CPI-C Parameters and Values


	Corporate Info \| News \| Solutions \| Products \| Partners \| Services \| Events \| Download \| How To Buy
	http://www.oracle.com/technology/documentation/index.html \| Search \| PDF Files \| Contact \|

eLink Adapter for Mainframe Samples Guide Doc Home \| BEA eLink Adapter for Mainframe Samples Guide \| Previous Topic \| Next Topic \| Contents \| Index

CPI-C Verbs

The following tables show the parameters required for each CPI-C verb and the permissible values when used with BEA eLink Adapter for Mainframe software.

CMINIT Parameters

Parameter
In/Out
Value
Usage

conversation_ID

Output

Returned by the SNA Stack

Used on every other call

sym_dest_name

Input

Symbolic name that represents the partner LU, the modename, and the TP (Tuxedo service)

If blank, SET calls must be made to initialize conversation parameters

return code

Output

See list of CPI-C return codes

If not CM_OK, conversation fails.

Parameter	In/Out	Value	Usage
conversation_ID	Output	Returned by the SNA Stack	Used on every other call
sym_dest_name	Input	Symbolic name that represents the partner LU, the modename, and the TP (Tuxedo service)	If blank, SET calls must be made to initialize conversation parameters
return code	Output	See list of CPI-C return codes	If not CM_OK, conversation fails.

CMALLC Parameters

Parameter
In/Out
Value
Usage

conversation_ID

Input

Value returned from CMINIT

return_code

Output

See list of CPI-C return codes

If not CM_OK, or CM_ALLOCATION_FAILURE_RETRY, conversation fails

Parameter	In/Out	Value	Usage
conversation_ID	Input	Value returned from CMINIT
return_code	Output	See list of CPI-C return codes	If not CM_OK, or CM_ALLOCATION_FAILURE_RETRY, conversation fails

CMRCV Parameters

Parameter
In/Out
Value
Usage

conversation_ID

Input

Value returned from CMINIT

buffer

Input

Name of variable to be populated by data received

requested_length

Input

Name of variable where amount of data to be received is posted

0 <= requested_length < 32K

data_received

Output

CM_COMPLETE

CM_INCOMPLETE

Indicates enough data in LU buffer to satisfy requested length

Another CMRCV must be issued to get enough data to satisfy the requested length

received-length

Output

Name of variable where amount of data returned is posted

Returned data may be shorter than requested amount including zero

status_received

Output

CM_NO_STATUS

CM_SEND_RECEIVED

No state change.

State of the conversation is changed to send

request_to_send_received

Output

CM_REQ_TO_SEND_ RECEIVED

CM_REQ_TO_SEND_ NOT_RECEIVED

Receiver enters send state.

Partner has not requested a state change

return_code

Output

See list of CPI-C return codes

If not CM_OK or CM_DEALLOCATE_NORMAL, the conversation is deallocated.

Parameter	In/Out	Value	Usage
conversation_ID	Input	Value returned from CMINIT
buffer	Input	Name of variable to be populated by data received
requested_length	Input	Name of variable where amount of data to be received is posted	0 <= requested_length < 32K
data_received	Output	CM_COMPLETE CM_INCOMPLETE	Indicates enough data in LU buffer to satisfy requested length Another CMRCV must be issued to get enough data to satisfy the requested length
received-length	Output	Name of variable where amount of data returned is posted	Returned data may be shorter than requested amount including zero
status_received	Output	CM_NO_STATUS CM_SEND_RECEIVED	No state change. State of the conversation is changed to send
request_to_send_received	Output	CM_REQ_TO_SEND_ RECEIVED CM_REQ_TO_SEND_ NOT_RECEIVED	Receiver enters send state. Partner has not requested a state change
return_code	Output	See list of CPI-C return codes	If not CM_OK or CM_DEALLOCATE_NORMAL, the conversation is deallocated.

CMSEND Parameters

Parameter
In/Out
Value
Usage

conversation_ID

Input

Value returned from CMINIT

buffer

Input

Name of buffer area containing data to be sent

send_length

Input

Length of data in buffer to be sent

0 <= data < 32K

req_to_send_received

Output

The name of the variable that contains the indication that indicates CM_REQ_TO_SEND_ RECEIVED

CM_REQ_TO_SEND_ NOT_RECEIVED

Partner request to change state to send

Partner has not requested a state change

return_code

Output

See list of CPI-C return codes

If not CM_OK, the conversation is deallocated

Parameter	In/Out	Value	Usage
conversation_ID	Input	Value returned from CMINIT
buffer	Input	Name of buffer area containing data to be sent
send_length	Input	Length of data in buffer to be sent	0 <= data < 32K
req_to_send_received	Output	The name of the variable that contains the indication that indicates CM_REQ_TO_SEND_ RECEIVED CM_REQ_TO_SEND_ NOT_RECEIVED	Partner request to change state to send Partner has not requested a state change
return_code	Output	See list of CPI-C return codes	If not CM_OK, the conversation is deallocated

CMACCP Parameters

Parameter
In/Out
Value
Usage

conversation _ID

Output

Returned from the LU

return_code

Output

See list of CPI-C return codes

If not CM_OK, the accept fails and no conversation is started

Parameter	In/Out	Value	Usage
conversation _ID	Output	Returned from the LU
return_code	Output	See list of CPI-C return codes	If not CM_OK, the accept fails and no conversation is started