Transfer CFT 3.2.2 Users Guide Synchronous communication services Call syntax rc = cftau (verb,param) rc = cftac (verb,param) Where: cftau indicates that syntax analysis is requested cftac indicates that syntax analysis is not requested <verb> is the command that you want to process <param> is a character string of variable length that contains the command parameters. The end of the field is defined by a character initially set to low-value <rc> is the return code The available <verbs> are listed in the following table. <verb> Service COM Communication mode GETXINFO Retrieving information about a transfer made from a synchronous request The available <param> are listed in the following table. <verb> <param> Description com param The COM command parameter structure is as follows: <medium type> = <Medium name> The medium type consists in an uppercase letter: 'F' for file 'M' for mailbox 'T' for the TCP/IP synchronous medium 'C' for the configuration file (ConfigFileName) The medium name is the: Filename, if the medium type is 'F' Mailbox name, if the medium type is 'M' Name of the communication channel, if the medium type is 'T' Name of the configuration file containing the medium of communication characteristics, if the medium type is C. getxinfo xinf Information about a transfer in the format described in the cftapi.h file. Step procedure Use the COM command to define the synchronous medium. Open the synchronous communication. cftau ("COM",C=<configuration file>); configuration file is a text file that contains the following lines : # TCP/IP COMMUNICATION TYPE = TCP NAME = xhttp://localhost:<COM Synchron port value> TIMEOUT = <timeout to reach> Write the command. This is not specific to synchronous mediums. cftau (verb,param) Retrieve information using the GETXINFO service. cftApiInfT cftinfo; cftau("GETXINFO",(char*) &cftinfo); To view the synchronous communication template containing details and an example, see tcftsyn. Return codes Mnemonic Description CAPI_NOERR No error. CAPI_FUNC_UNDEF Command not valid. CAPI_COM_OPEN Communication medium opening error. CAPI_COM_WRITE Communication medium write error. CAPI_COM_CLOSE Communication medium closing problem. CAPI_COM_ALLOC Communication medium allocation problem. CAPI_COM_ERR Communication medium not available on this system. Related Links
Synchronous communication services Call syntax rc = cftau (verb,param) rc = cftac (verb,param) Where: cftau indicates that syntax analysis is requested cftac indicates that syntax analysis is not requested <verb> is the command that you want to process <param> is a character string of variable length that contains the command parameters. The end of the field is defined by a character initially set to low-value <rc> is the return code The available <verbs> are listed in the following table. <verb> Service COM Communication mode GETXINFO Retrieving information about a transfer made from a synchronous request The available <param> are listed in the following table. <verb> <param> Description com param The COM command parameter structure is as follows: <medium type> = <Medium name> The medium type consists in an uppercase letter: 'F' for file 'M' for mailbox 'T' for the TCP/IP synchronous medium 'C' for the configuration file (ConfigFileName) The medium name is the: Filename, if the medium type is 'F' Mailbox name, if the medium type is 'M' Name of the communication channel, if the medium type is 'T' Name of the configuration file containing the medium of communication characteristics, if the medium type is C. getxinfo xinf Information about a transfer in the format described in the cftapi.h file. Step procedure Use the COM command to define the synchronous medium. Open the synchronous communication. cftau ("COM",C=<configuration file>); configuration file is a text file that contains the following lines : # TCP/IP COMMUNICATION TYPE = TCP NAME = xhttp://localhost:<COM Synchron port value> TIMEOUT = <timeout to reach> Write the command. This is not specific to synchronous mediums. cftau (verb,param) Retrieve information using the GETXINFO service. cftApiInfT cftinfo; cftau("GETXINFO",(char*) &cftinfo); To view the synchronous communication template containing details and an example, see tcftsyn. Return codes Mnemonic Description CAPI_NOERR No error. CAPI_FUNC_UNDEF Command not valid. CAPI_COM_OPEN Communication medium opening error. CAPI_COM_WRITE Communication medium write error. CAPI_COM_CLOSE Communication medium closing problem. CAPI_COM_ALLOC Communication medium allocation problem. CAPI_COM_ERR Communication medium not available on this system.