VFN_GetCounter()
This subprocedure retrieves the current transaction counter from the device using Verifone’s Get Counter service.
Subprocedure Prototype
|
Returns *OFF if an error occurs during processing, *ON otherwise. |
|
|
|
|
|
Optional parameter that, if passed, will contain error data returned from the subprocedure. |
|
Override the default value set in VFN_Register() or REGVFNDVC. Default Value: |
|
Override the default value set in VFN_Register() or REGVFNDVC. Default Value: |
|
Override the default value set in VFN_Register() or REGVFNDVC. Default Value: |
Example Code
// Example Program: T_COUNTER
// Description:
// This is a test program to illustrate how to call the VFN_GetCounter()
// 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 CounterReqDS LikeDS(VFN_GetCounterReqDS_t) Inz(*LikeDS);
// This will store parsed response data from the API call
Dcl-Ds CounterRspDS LikeDS(VFN_GetCounterRspDS_t) Inz(*LikeDS);
reset ErrorDS;
reset CounterReqDS;
reset CounterRspDS;
// This must be a device which has been successfully registered
// with VFN_Register() and which exists in VFNDVC.
CounterReqDS.DeviceID = 'test';
// These fields can be assigned to a log file name, and will write the
// request and response xml data to the logging directory.
CounterReqDS.RequestLog = 'T_COUNTER_Request.xml';
CounterReqDS.ResponseLog = 'T_COUNTER_Response.xml';
// If VFN_Counter() 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_GetCounter( CounterReqDS : CounterRspDS : 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: ' + CounterRspDS.ResponseText
+ NewLine );
WriteToJobLog( 'Result: ' + CounterRspDS.Result + NewLine );
WriteToJobLog( 'Result Code: ' + CounterRspDS.ResultCode
+ NewLine );
WriteToJobLog( 'Termination Status: ' + CounterRspDS.TerminationStatus
+ NewLine );
WriteToJobLog( 'Counter: ' + %Char(CounterRspDS.Counter) + NewLine );
endif;
*INLR = *On;
return;
Data Structures
|
|
|
Required The ID of the payment device, registered in VFNDVC, of which the Counter is being queried. |
|
Specifies the file name or path of the request log file. Will have no effect if logging is not enabled. Example: |
|
Specifies the file name or path of the response log file. Will have no effect if logging is not enabled. Example: |
|
|
|
This field corresponds to the field RESPONSE_TEXT in your device's Verifone documentation. |
|
This field corresponds to the field RESULT in your device's Verifone documentation. |
|
This field corresponds to the field RESULT_CODE in your device's Verifone documentation. |
|
This field corresponds to the field TERMINATION_STATUS in your device's Verifone documentation. |
|
This field corresponds to the field COUNTER in your device's Verifone documentation. |