VFN_RetrieveVersion()

This subprocedure calls Verifone’s Retrieve Version service.

Subprocedure Prototype

D VFN_RetrieveVersion...
D                 PR              N   Extproc('VFN_RetrieveVersion')

Returns *OFF if an error occurs during processing, *ON otherwise.

D  pRequestDS                         LikeDS(VFN_RetrieveVersionReqDS_t)
D                                     Const
 
D  pResponseDS                        LikeDS(VFN_RetrieveVersionRspDS_t)
 
D  pErrorDS                           LikeDS(VFN_ErrorDS_t)
D                                     Options(*Nopass)

Optional parameter that, if passed, will contain error data returned from the subprocedure.

Example Code


// Example Program: T_RETVER // Description: // This is a test program to illustrate how to call the // VFN_RetrieveVersion() subprocedure. Ctl-Opt DftActGrp(*No) ActGrp(*Caller) BndDir('PTTIBND'); /COPY QRPGLECPY,VFNCB // This is included for demo output purposes. Dcl-Pr WriteToJobLog Int(10) Extproc('Qp0zLprintf'); pString Pointer Value Options(*String); End-Pr; Dcl-C NewLine x'15'; // This will capture returned error information Dcl-Ds ErrorDS LikeDS(VFN_ErrorDS_t) Inz(*LikeDS); // This will be used to pass request information to the API call Dcl-Ds RetrieveVersionReqDS LikeDS(VFN_RetrieveVersionReqDS_t) Inz(*LikeDS); // This will store parsed response data from the API call Dcl-Ds RetrieveVersionRspDS LikeDS(VFN_RetrieveVersionRspDS_t) Inz(*LikeDS); reset ErrorDS; reset RetrieveVersionReqDS; reset RetrieveVersionRspDS; // This must be a device that has already been successfully registered // with VFN_Register() and which exists in VFNDVC. RetrieveVersionReqDS.DeviceID = 'test'; // These fields can be assigned a log file name, and will write the // request and response xml data to the logging directory. RetrieveVersionReqDS.RequestLog = 'T_RETVER_Request.xml'; RetrieveVersionReqDS.ResponseLog = 'T_RETVER_Response.xml'; // if VFN_RetrieveVersion() returns *Off, it means that an error occurred // as part of the overall communication process, and the information // will be in ErrorDS - ErrorDS.Message is the main field to look at // for troubleshooting. if not VFN_RetrieveVersion( RetrieveVersionReqDS : RetrieveVersionRspDS : ErrorDS ); // handle error WriteToJobLog( 'Message ID: ' + ErrorDS.MessageId + NewLine ); WriteToJobLog( 'Message: ' + ErrorDS.Message + NewLine ); *INLR = *On; return; else; // Now you can check the response data structure for any status info // or data returned from the device: WriteToJobLog( 'Response Text: ' + RetrieveVersionRspDS.ResponseText + NewLine ); WriteToJobLog( 'Result: ' + RetrieveVersionRspDS.Result + NewLine ); WriteToJobLog( 'Response Code: ' + RetrieveVersionRspDS.ResultCode + NewLine ); WriteToJobLog( 'Termination Status: ' + RetrieveVersionRspDS.TerminationStatus + NewLine ); WriteToJobLog( 'Version: ' + RetrieveVersionRspDS.VersionInfo + NewLine ); endif; *INLR = *On; return;

Data Structures

D VFN_RetrieveVersionReqDS_t...
D                 DS                  Qualified Template Inz
 
D  DeviceID                           Like(VFN_DeviceId_t)

Required

The ID of the payment device, registered in VFNDVC, of which the version is being queried.

D  RequestLog                         Like(VFN_Var1Kv_t)

Specifies the file name or path of the request log file. Will have no effect if logging is not enabled.

Example: "req_log.txt","/tmp/logs/request.txt"

D  ResponseLog                        Like(VFN_Var1Kv_t)

Specifies the file name or path of the response log file. Will have no effect if logging is not enabled.

Example: "rsp_log.txt","/tmp/logs/response.txt"

D  DisplayVersion...
D                                 N
 
D  ConnectTimeout...
D                                3P 0 Inz(-1)

Override the default value set in VFN_Register() or REGVFNDVC.

Default Value: -1

D  WriteTimeout...
D                                3P 0 Inz(-1)

Override the default value set in VFN_Register() or REGVFNDVC.

Default Value: -1

D  ReadTimeout...
D                                3P 0 Inz(-1)

Override the default value set in VFN_Register() or REGVFNDVC.

Default Value: -1

D VFN_RetrieveVersionRspDS_t...
D                 DS                  Qualified Template Inz
 
D  ResponseText                       Like(VFN_Var1Kv_t)

This field corresponds to the field RESPONSE_TEXT in your device's Verifone documentation.

D  Result                             Like(VFN_Var1Kv_t)

This field corresponds to the field RESULT in your device's Verifone documentation.

D  ResultCode                   10A   Varying

This field corresponds to the field RESULT_CODE in your device's Verifone documentation.

D  TerminationStatus...
D                                     Like(VFN_Var1Kv_t)

This field corresponds to the field TERMINATION_STATUS in your device's Verifone documentation.

D  VersionInfo...
D                                     Like(VFN_Var1Kv_t)

This field corresponds to the field VERSION_INFO in your device's Verifone documentation.