Important Notice

The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.

                                                     ◄Up► ◄Next► ◄Previous►
────────────────────────────────────────────────────────────────────────────
 
int GetKeyString(nString, lpStringOut, iSize)
int nString;
LPSTR lpStringOut;
WORD iSize;
 
The GetKeyString function copies the name of a specified key to the given
buffer. The function must be exported by each language-specific keyboard
library. The keyboard driver calls the function when the driver's
GetKeyNameText function has been called by an application.
 
Parameter    Description
────────────────────────────────────────────────────────────────────────────
 
nString      Specifies the string list index.
 
lpStringOut  Points to the buffer to receive the null-terminated key name.
 
iSize        Specifies the maximum number of bytes the buffer can hold. The
             lpStringOut parameter points to this buffer
 
Return Value
 
The return value is the size of the string (excluding the terminating zero
byte) in the AX register.
 
Comments
 
The export ordinal for this function is 2.
 
The GetKeyNameText function checks for this function in the
language-specific library to obtain the local version of the key name.
 
                                      ♦