Description The card is removed from its present position (card inserted into device, card entering, unknown position) and stored in the retain bin; applicable to motor-driven card readers only. The ID card unit sends an event, if the storage capacity of the retain bin is reached. If the storage capacity has already been reached, and the command cannot be executed, an error is returned and the card remains in its present position.
If the execution of this command is performed without errors, the total number of cards retained includes the current card. If, however, an error occurs during the execution, the total number of cards retained does not include the current card.
Input Param None.
Output Param LPWFSIDCRETAINCARD lpRetainCard;
typedef struct _wfs_idc_retain_card
{
USHORT usCount;
WORD fwPosition;
} WFSIDCRETAINCARD, * LPWFSIDCRETAINCARD;
usCount
Total number of ID cards retained up to and including this operation, since the last WFS_CMD_IDC_RESET_COUNT command was executed.
fwPosition
Position of card; only relevant if card could not be retained. Possible positions:
Value Meaning
WFS_IDC_MEDIAUNKNOWN The position of the card can not be determined with the device in its current state.
WFS_IDC_MEDIAPRESENT The card is present in the reader.
WFS_IDC_MEDIAENTERING The card is in the entering position (shutter).
Error Codes The following additional error codes can be generated by this command:
Value Meaning
WFS_ERR_IDC_MEDIAJAM The card is jammed. Operator intervention is required.
WFS_ERR_IDC_NOMEDIA No card has been inserted. The fwPosition parameter has the value WFS_IDC_MEDIAUNKNOWN.
WFS_ERR_IDC_RETAINBINFULL The retain bin is full; no more cards can be retained. The current card is still in the device.
Events The following additional events can be generated by this command:
Value Meaning
WFS_USRE_IDC_RETAINBINTHRESHOLD The retain bin reached a threshold value.
Comments This is a fundamental capability of an ID card unit; thus if a retain request is received by a device with no retain capability, the WFS_ERR_UNSUPP_COMMAND error is returned.