FSF.FarNameToKey

Far Manager

previous page next page

FarNameToKey

main | FarStandardFunctions
The FSF.FarNameToKey is used to convert a literal key name to an internal FAR key code. 
int WINAPI FarNameToKey(
  const char *Name
);

Parameters

Name
Points to a string containing a literal key name that you want to convert to an internal FAR key code.

Return value

If conversion succeeds an internal FAR key code is returned, otherwise if the passed Name is not known to FAR, -1 is returned.

Remarks

  1. If the literal key name contains Ctrl or Alt part and the "letter", this "letter" will be uppercased. For example, FarNameToKey("CtrlAltz") will return KEY_CTRLALTZ.
  2. If the literal key name contains Ctrl or Alt and the "letter from the national alphabet" - this "letter" will be converted to it's keyboard equivalent and uppercased. For example, FarNameToKey("CtrlУ") will return KEY_CTRLE.
  3. Shift-"letter" combination will be converted to the "LETTER" key (Shift part will be removed and the "letter" will be uppercased).
previous page start next page