MagTek MAGTEK User Manual

Page 59

Section 5. Application Programmable Interface

dwApplicationID

Application ID. This number identifies which application within the device the operation is
directed. Each device has its own set of embedded applications and associated IDs. Refer to the
device's Command Reference Manual for the available Application IDs and their function.

dwCommandID

Command ID. This number identifies which specific command to perform within the device
application specified by the dwApplicationID member. Each device application has its own set of
commands and associated IDs. Refer to the device's Command Reference Manual for the
available Application/Command IDs and their function.

dwResultCode

Command Result Code. This value indicates whether the command was completed successfully,
and if not, what was the reason for failure. It is used also by some notifications. Each device
application / command has its own set of result codes. Refer to the device's Command Reference
Manual for the possible result codes.

lpszPropertyName

Property Name. Properties can be identified by name or by numeric ID. When obtaining
(McpGet) or modifying (McpSet) property values, this field contains a pointer to a null
terminated string of 8-bit ANSI characters representing the name of the property being obtained
or modified. Either this member or dwPropertyID is used to identify the property being obtained
or modified. A driver device instance property can only be accessed by name. A device
application property can only be accessed by property ID. LpszPropertyName should be set to
null when accessing device application properties. If both lpszPropertyName and dwPropertyID
are specified, the value specified by this member takes precedent.

dwPropertyID

Property ID. Device applications identify properties by numeric ID. When obtaining (McpGet)
or modifying (McpSet) property values, this field contains the ID of the property being obtained
or modified. Either this member or lpszPropertyName is used to identify the property being
obtained or modified. If both lpszPropertyName and dwPropertyID are specified, the value
specified by lpszPropertyName takes precedent. Therefore, LpszPropertyName should be set to
null when accessing device application properties.