Windows: xxclient.dll, zlib.dll

Unix/Linux: libxxclient.so

• char * pszServer
  • [in] XX1 Server ip-address or URL
• int port
  • [in] XX1 Server SOAP port
• char * pszCertificate
  • [in]
    • PGP: optional, path and file name of certificate database
    • SSL: optional, path of certificate databases
• char * pszTC
  • [in] Transaction Control Data as XML format
• char * pszReq
  • [in] Request message as XML format
• int cbReq
  • [in] Length of request message in pszReq
• char ** ppszRspTC
  • [out] Returned Transaction Control Data as XML format
• char ** ppszRsp
  • [out] Response message as XML format
• int * pcbRsp
  • [out] Length of response message in ppszRsp
• char ** ppszError
  • [out] Error text
• unsigned long ulTimeout
  • [in] Socket connect timeout in seconds or XXC_DEFAULTTIMEOUT
• unsigned long ulFlags
  • [in] Transaction Flags

Sends a stateless transaction to the server.

Return Values:

• If no error occurs, the return code is XXC_OK (0) and ppszRsp contains the response XML.

Remarks:

• XxcFreeBuffer must be called on all returned strings.

• char * pszServer
  • [in] XX1 Server ip-address or URL
• int port
  • [in] XX1 Server SOAP port
• char * pszCertificate
  • [in]
    • PGP: optional, path and file name of certificate database
    • SSL: optional, path of certificate databases
• char * pszTC
  • [in] Transaction Control Data as XML format
• char ** ppszError
  • [out] Error text
• unsigned long pulStatus
  • [out] Return code
• unsigned long ulTimeout
  • [in] Socket connect timeout in seconds or XXC_DEFAULTTIMEOUT
• unsigned long ulFlags
  • [in] Transaction Flags

Obtains a session context from the host and locks it for other users.

Return Values:

• If no error occurs, the return code is a context handle and pulStatus is set to XXC_OK.
• On error the return value is NULL and pulStatus contains the error code.

Remarks:

• XxcFreeBuffer must be called on all returned strings.
• Use XxcReleaseSession when done with sessioned transactions to unlock the host context.

• HXXCONTEXT hContext
  • [in] Context handle returned by XxcGetSession function
• char * pszTC
  • [in] Transaction Control Data as XML format
• char ** ppszError
  • [out] Error text
• unsigned long ulFlags
  • [in] Transaction Flags

Releases context obtained with XxcGetSession and unlocks the session on the host.

Return Values:

• If no error occurs, the return code is XXC_OK (0).

Remarks:

• XxcFreeBuffer must be called on all returned strings.
• Connections will be closed.
• The XXF_HTTPKEEPALIVE flag has no effect.

• HXXCONTEXT hContext
  • [in] Context handle returned by XxcGetSession function
• char * pszTC
  • [in] Transaction Control Data as XML format
• char * pszReq
  • [in] Request message as XML format
• int cbReq
  • [in] Length of request message in pszReq
• char ** ppszRspTC
  • [out] Returned Transaction Control Data as XML format
• char ** ppszRsp
  • [out] Response message as XML format
• int * pcbRsp
  • [out] Length of response message in ppszRsp
• char ** ppszError
  • [out] Error text
• unsigned long ulFlags
  • [in] Transaction Flags

Sends a transaction to the server using a host context.

Return Values:

• If no error occurs, the return code is XXC_OK (0) and ppszRsp contains the response XML.

Remarks:

• XxcFreeBuffer must be called on all returned strings.
• It is highly recommended to use the XXF_HTTPKEEPALIVE flag with all sessioned transactions.

• char * pszBuffer
  • [in] String returned by any function/parameter

Frees memory allocated for returned strings.

Remarks:

• This function must be called on all returned string (char *) parameters after each invocation of the following functions:
  • XxcTransaction
  • XxcSessionedTransaction
  • XxcGetSession
  • XxcReleaseSession