Data Transformation Engine Services Guide

Chapter 17 – Calling Interface for Functions
104
SzErrMsg Used as output, contains the string message based on nReturn.
LpAdaptParms Used as input, contains the adapter specific parameter block of the “parsed” command
LpContext Used as output, contains the adapter specific context structure containing handles etc for the open
connection
LpszMapDirectory Used as input, the full path to the directory of the MMC file
WCardNum Used as input, the card number (offset from 0?)
WCleanupAction Used as input, the action to be taken on cleanup
WScope Used as input, the scope of the transaction
UUnitSize Used as input, the size of the unit to fetch
BBurst Used as input, TRUE if the card mode is burst.
BFromRule Used as input, TRUE if calling from a rule (GET or PUT)
BSource Used as input, TRUE if calling as a source of data (input card or GET function)
LpfnMS Used as input, a callback function to the map status function
LpMS Used as input, a pointer to the map status procedure used to communicate to the map status function
DwRecords Not used.
The call is made after the ‘Validate Command’ which has populated the lpAdaptParms
structure. No command line parsing is therefore required in the adapter’s Put, Get or
Delete calls. Any handles or connection contexts that are established by the adapter are
returned in fields in the adapter’s lpContext structure.
Get Command
This function is called by the Resource Manager to get data from the resource.
The function has the prototype:
void Get ( EXITPARAM *lpep );
DwSize The size of EXITPARAM to assure correct compatibility.
DwToLen If called from a GET mapping function in a rule, this contains the size of the data passed in the third
parameter.
DwFromLen Used on output, the size of the data returned by the adapter
dwMapInstance Used as input, a unique identifier based on an instance of a particular map.
Lpv Used as input, contains the value that was set up in the connect call (if applicable). Whatever value is set by
the adapter, will be returned to the adapter on the cleanup call.
LpszCmdLine Used as input, the command line for the card.
lpDataToApp If called from a GET mapping function in a rule, this contains the data passed in the third parameter.
lpDataFromApp Used as output, the data returned by the adapter
URetryCount Used as input, a retry count specified by the user.
uRetryInterval Used as input, a retry interval (in seconds) specified by the user.
BRollback Used as input, whether or not the user specified rollback.
BCleanup Used as input and output – if set on calling the adapter is being called to cleanup. Otherwise, the adapter can
set the cleanup flag to indicate that it expects to be called back for a cleanup.
NReturn Used as output, contains the return code representing whether the get succeeded or not.
SzErrMsg Used as output, contains the string message based on nReturn.
SzFile Used as output, can specify a file name to be used in place of buffering the data.
LpCmdStruct Used as input, the command structure for the card (if using 2.0 style commands). Mututally exclusive with
lpszCmdLine. [Not supported for 2.0]
lpAdaptParms Used as input, contains the adapter specific parameter block.
LpContext Used as input, contains the adapter specific context structure containing handles etc for the open connection
lpszMapDirectory Used as input, the full path to the directory of the MMC file
wCardNum Used as input, the card number (offset from 0?)
wCleanupAction Used as input, the action to be taken on cleanup
wScope Used as input, the scope of the transaction
uUnitSize Used as input, the size of the unit to fetch
bBurst Used as input, TRUE if the card mode is burst. Used as output, set to FALSE to indicate that this is the end
of the burst.
bFromRule Used as input, set to FALSE if an input card, or TRUE if a GET function
bSource Used as input, set to TRUE
lpfnMS Used as input, a callback function to the map status function
lpMS Used as input, a pointer to the map status procedure used to communicate to the map status function
dwRecords Used as output, the number of records (the meaning of which is adapter specific) returned by the adapter