3.40 AIFPORTSEND

	MPE documents
	Complete PDF
	Table of Contents
	Index
⇓ Page Bottom
Syntax
Parameters
Operation Notes
Item Descriptions

⇑ Page Top

Syntax

               REC             I32      CA
 AIFPORTSEND ( overall_status, port_id, message_buffer,

               I32             I32            I32
               message_length, envelope_code, message_id,

               I32A           @64A        RECA
               itemnum_array, item_array, itemstatus_array );
  

Parameters

overall_status

record by reference (required)

Returns the overall status of the call. A zero indicates a successful call. A negative value indicates an error in the overall call, not specific to any particular item. A positive value indicates the last element in itemstatus_array, signaling an error condition. Refer to appendix A for meanings of status values.

Record type: status_type (Refer to appendix B.)

port_id

32-bit signed integer by reference (required)

Passes a port ID, returned from a successful call to AIFPORTOPEN. This parameter specifies the port that is to receive the message.

message_buffer

character array (required)

Passes the actual message to send through the specified port.

message_length

32-bit signed integer by value (required)

Passes the length, in bytes, of the message buffer to send through the specified port.

envelope_code

32-bit signed integer by value (optional)

Passes an integer code associated with the envelope portion of the message. The use of this value is application dependent; for example, it can be used to identify the type of message being sent, so the receiving process can identify the message type without accessing the actual message buffer. If this parameter is not supplied, envelope_code is defaulted to zero.

Default: 0

message_id

32-bit signed integer by reference (optional)

A code returned by AIFPORTSEND to identify this particular message.

Default: nil

itemnum_array

32-bit signed integer array by reference (optional)

This is an array of integers, terminated by an element containing the value zero, used to define the corresponding option given in the item_array parameter. If this optional parameter is specified, the item_array parameter and the itemstatus_array parameter must both be supplied.

Default: nil

item_array

64-bit address array by reference (optional)

An array with the same number of elements as the itemnum_array parameter, each of which is a globalanyptr that points to the appropriate type needed by each particular item number. The value used for each option is taken from, or returned to, the location pointed to by the globalanyptr in this array. When this parameter is supplied, the itemnum_array parameter and the itemstatus_array parameter must both be supplied.

Array type: globalanyptr

Default: nil

itemstatus_array

record array by reference (optional)

If problems are detected with specific items, an error status is placed in the corresponding element of this array for each item with an error. The overall status parameter indicates whether any individual items contained errors, and the element of the last detected error. This array must contain as many elements as are contained in the itemnum_array and item_array parameters.

A nonzero value indicates an error, but a valid option does not set the value to zero, so this array should be initialized to all zeros before making the call.

Array type: status_type (Refer to appendix B.)

Default: nil