Description This command returns information about the names of the Function Keys supported by the device. Location information is also returned for the supported FDKs (Function Descriptor Keys) or Touch Screen Pads if this XFS interface is used for Touch Screen input.
Input Param LPULONG lpulFDKMask;
lpulFDKMask
Mask for the FDKs for which additional information is requested.
If 0x00000000, only information about function keys is returned.
If 0xFFFFFFFF, information about all the supported FDKs is returned.
Output Param LPWFSPINFUNCKEYDETAIL lpFuncKeyDetail;
typedef struct _wfs_pin_func_key_detail
{
ULONG ulFuncMask;
USHORT usNumberFDKs;
LPWFSPINFDK * lppFDKs;
} WFSPINFUNCKEYDETAIL, * LPWFSPINFUNCKEYDETAIL;
ulFuncMask
Specifies the function keys available for this physical device as a combination of the following flags:
WFS_PIN_FK_0
WFS_PIN_FK_1
WFS_PIN_FK_2
WFS_PIN_FK_3
WFS_PIN_FK_4
WFS_PIN_FK_5
WFS_PIN_FK_6
WFS_PIN_FK_7
WFS_PIN_FK_8
WFS_PIN_FK_9
WFS_PIN_FK_ENTER
WFS_PIN_FK_CANCEL
WFS_PIN_FK_CLEAR
WFS_PIN_FK_BACKSPACE
WFS_PIN_FK_HELP
WFS_PIN_FK_DECPOINT
WFS_PIN_FK_00
WFS_PIN_FK_000
WFS_PIN_FK_RES1 (reserved for future use)
WFS_PIN_FK_RES2 (reserved for future use)
WFS_PIN_FK_RES3 (reserved for future use)
WFS_PIN_FK_RES4 (reserved for future use)
WFS_PIN_FK_RES5 (reserved for future use)
WFS_PIN_FK_RES6 (reserved for future use)
WFS_PIN_FK_RES7 (reserved for future use)
WFS_PIN_FK_RES8 (reserved for future use)
The remaining 6 bit masks may be used as vendor dependent keys.
WFS_PIN_FK_OEM1
WFS_PIN_FK_OEM2
WFS_PIN_FK_OEM3
WFS_PIN_FK_OEM4
WFS_PIN_FK_OEM5
WFS_PIN_FK_OEM6
usNumberFDKs
This value indicates the number of FDK structures returned. This number can be less than the number of keys requested, if any keys are not supported.
lppFDKs
Pointer to an array of pointers to FDK structures.
typedef struct _wfs_pin_fdk
{
ULONG ulFDK;
USHORT usXPosition;
USHORT usYPosition;
} WFSPINFDK, * LPWFSPINFDK;
ulFDK
Specifies the code returned by this FDK, defined as one of the following values:
WFS_PIN_FK_FDK01
WFS_PIN_FK_FDK02
WFS_PIN_FK_FDK03
WFS_PIN_FK_FDK04
WFS_PIN_FK_FDK05
WFS_PIN_FK_FDK06
WFS_PIN_FK_FDK07
WFS_PIN_FK_FDK08
WFS_PIN_FK_FDK09
WFS_PIN_FK_FDK10
WFS_PIN_FK_FDK11
WFS_PIN_FK_FDK12
WFS_PIN_FK_FDK13
WFS_PIN_FK_FDK14
WFS_PIN_FK_FDK15
WFS_PIN_FK_FDK16
WFS_PIN_FK_FDK17
WFS_PIN_FK_FDK18
WFS_PIN_FK_FDK19
WFS_PIN_FK_FDK20
WFS_PIN_FK_FDK21
WFS_PIN_FK_FDK22
WFS_PIN_FK_FDK23
WFS_PIN_FK_FDK24
WFS_PIN_FK_FDK25
WFS_PIN_FK_FDK26
WFS_PIN_FK_FDK27
WFS_PIN_FK_FDK28
WFS_PIN_FK_FDK29
WFS_PIN_FK_FDK30
WFS_PIN_FK_FDK31
WFS_PIN_FK_FDK32
usXPosition
For FDKs, specifies the FDK position relative to the Left Hand side of the screen expressed as a percentage of the width of the screen.
usYPosition
For FDKs, specifies the FDK position relative to the top of the screen expressed as a percentage of the height of the screen.
Error Codes There are no additonal error codes generated by this command.
Comments None.