FSF.FarKeyToName

Far Manager

previous page next page

FarKeyToName

main | FarStandardFunctions
The FSF.FarKeyToName is used to convert an internal FAR key code to a string. 
BOOL WINAPI FarKeyToName(
  int Key,
  char *KeyText,
  int Size
);

Parameters

Key
Internal FAR key code to convert to a string.
KeyText
String that will receive the result of conversion.
Size
The size of converted string, not including a null character, that will be copied to KeyText, or 0 to use the whole length of converted string.

Return value

If conversion succeeds TRUE is returned, otherwise if the passed Key is not known to FAR, FALSE is returned.

Remarks

If you use 0 in Size, then KeyText must be at least 32 bytes long.
previous page start next page