3.1 WFS_INF_CHK_STATUS

Description

This function is used to query the status of the device and the service.

Input Param

None.

Output Param
LPWFSCHKSTATUS
struct _wfs_chk_status
     {
     WORD     fwDevice;     
     WORD     fwMedia; 
     WORD     fwInk; 
     DWORD    dwMode;     
     WORD     fwLamp;     
     LPSTR    lpszExtra;
     } WFSCHKSTATUS, * LPWFSCHKSTATUS;

fwDevice

Specifies the state of the check reader device as one of:

WFS_CHK_DEVONLINE Device is online.
WFS_CHK_DEVOFFLINE Device is offline.
WFS_CHK_DEVPOWEROFF Device is powered off.
WFS_CHK_DEVNODEVICE No device is connected.

fwMedia

Specifies the status of the media in the check reader as one of:

WFS_CHK_MEDIANOTPRESENT No media is inserted in device.
WFS_CHK_MEDIAREQUIRED Insertion of media required.
WFS_CHK_MEDIAPRESENT Media inserted in device.
WFS_CHK_MEDIAJAMMED Media jam in device.

fwInk

Specifies the status of the ink in the check reader as one of:

WFS_CHK_INKFULL Ink supply in device is full.
WFS_CHK_INKLOW Ink supply in device is low.
WFS_CHK_INKOUT Ink supply in device is empty.

dwMode

Specifies the autofeed status of the check reader as one of:

WFS_CHK_MODEMANUAL Device is in manual mode.
WFS_CHK_MODEAUTOFEED Device is in autofeed mode.

fwLamp

Specifies the status of the check reader imaging lamp as one of:

WFS_CHK_LAMPOK The lamp is OK.
WFS_CHK_LAMPFADING The lamp should be changed.

lpszExtra

Points to a list of vendor-specific, or any other extended information. The information is returned as a series of “key=value” strings so that it is easily extensible by service providers. Each string is null-terminated, with the final string terminating with two null characters.

Error Code

There are no additional error codes generated by this command.

Comments

Applications which require or expect specific information to be present in the lpszExtra parameter may not be device or vendor-independent.