Function Calls

The following sections list all the function calls available when using a C Proxy API. They are categorized into the function calls that you must use for synchronous processing, asynchronous processing, and for available function calls that are independent of the type of cooperative flow. The detailed description of each function follows.

For synchronous processing, use the function calls listed in the following table:

Call	Description
ProxyExecute	Sends a transaction to a server and returns export data and messages.
n.a.	n.a.

For asynchronous processing, use the function calls listed in the following table:

Call	Description
ProxyExecuteAsync	Initiates an asynchronous cooperative flow.
ProxyCheckAsyncResponse	Interrogates the state of a specified request.
ProxyGetAsyncResponse	Attempts to obtain an asynchronous request's corresponding response.
ProxyIgnoreAsyncResponse	Informs the runtime that a specified response is to be ignored.

Note: The communication type of Tuxedo does not support Asynchronous Processing. Using these calls for Tuxedo results in erroneous behavior.

The functions listed in the following table are not dependent on the type of communication flow being used:

Functions Independent of Processing	Description
ProxyAllocateParamBlock	Creates the parameter block (data structure) that contains information required for the transaction.
ProxyClearClientPassword	Clears the password part of the parameter block.
ProxyClearClientUserid	Clears the userid part of the parameter block.
ProxyClearCommand.htm	Clears the command part of the parameter block.
ProxyClearDialect	Clears the dialect part of the parameter block.
ProxyClearExitMsgType	Clears the Exit Message Type of the parameter block.
ProxyClearExitStateMsg	Clears the Exit State message part of the parameter block.
ProxyClearExitStateNum	Clears the Exit State Number part of the parameter block.
ProxyClearNextLocation	Clears the next location part of the parameter block.
ProxyClearParamBlock	Clears the entire parameter block.
ProxyConfigureComm	Sets communication options.
ProxyDeleteParamBlock	Delete the psParamBlock structure.
ProxyGetClientPassword	Returns the value of the password part of the parameter block.
ProxyGetClientUserid	Returns the value of the Userid part of the parameter block.
ProxyGetCommand	Returns the value of the Command part of the parameter block.
ProxyGetDialect	Returns the value of the Dialect part of the parameter block.
ProxyGetExitMsgType	Returns the value of the Exit Message Type part of the parameter block. See also ProxyGetExitStateMsg and ProxyGetExitStateNum.
ProxyGetExitStateMsg	Returns the value of the Exit State Message part of the parameter block. See also, ProxyGetExitMsgType and ProxyGetExitStateNum.
ProxyGetExitStateNum	Returns the value of the Exit State Number part of the parameter block. See also, ProxyGetExitMsgType and ProxyGetExitStateMsg.
ProxyGetNextLocation	Returns the value of the Next Location part of the parameter block.
ProxySetClientPassword	Sets the client user password part of the parameter block that is sent to the server where the procedure step's executable code is installed.
ProxySetClientUserid	Sets the client user id part of the parameter block to be sent to the server where the procedure step's executable code is installed.
ProxySetCommand	Sets the value of the Command part of the parameter block.
ProxySetDialect	Sets the value of the Dialect part of the parameter block.
ProxySetNextLocation	Sets the value of the Next Location part of the parameter block.
ProxyStartTracing	Opens a file for debug/status information.
ProxyTraceOut	Writes a message to the trace file.
ProxyStopTracing	Closes the trace file opened by ProxyStartTracing.
ProxySetViewBlob	Set BLOB predicate view to input data, writes input data to BLOB.
ProxyGetViewBlob	Get BLOB predicate view data into output buffer, reads BLOB data into buffer.
ProxyClearViews	Clear view data.