QueryLayoutOrTipString function

Queries the specified string which represents the format of a keyboard layout list or text services profile list.


HRESULT CALLBACK QueryLayoutOrTipString(
  _In_ LPCWSTR psz,
  _In_ DWORD   dwFlags


psz [in]

A string that represents a keyboard layout list or a text services profile list.

dwFlags [in]

This must be 0.

Return value

This function can return one of these values.

Return codeDescription

All layouts or profiles defined in psz are valid.


One or more of the layouts or profiles defined in psz are invalid.



There is no import library available that defines this function, so it is necessary to obtain a pointer to this function using LoadLibrary and GetProcAddress.

Note  Using LoadLibrary incorrectly can compromise the security of your application by loading the wrong DLL. Refer to Dynamic-Link Library Search Order for information on how to correctly load DLLs with different versions of Microsoft Windows.

The string format of the layout list is:

<LangID 1>:<KLID 1>;[...<LangID N>:<KLID N>

The string format of the text service profile list is:

<LangID 1>:{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx};

The following is an example of a value for the psz parameter:



Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]