Share via

SipGetSupportedInputLanguages (Compact 2013)

  • Article

3/28/2014

This function retrieves the locale identifiers (LCIDs) of supported input languages of a software-based input panel (SIP).

Syntax

HRESULT SipGetSupportedInputLanguages(
    const CLSID* pclsid, 
  DWORD* pdwCount, 
  LCID* pInputLanguages
);

Parameters

  • pclsid
    [in] Pointer to the class identifier (CLSID) of the current SIP.
  • pdwCount
    [in, out] Pointer to the number of LCID values that the buffer to which pInputLanguages points can hold. If pInputLanguages is NULL, pdwCount returns the number of LCID values the buffer must be able to hold in order to specify all supported input languages.
  • pInputLanguages
    [out] Pointer to a buffer that receives the LCID of supported input languages. If this parameter is NULL, pdwCount returns the number of supported input languages for the SIP specified by pclsid. If this method returns LCID_NEUTRAL in pInputLanguages, the SIP supports all input languages.

Return Value

The following table shows the possible return values.

Value

Description

S_OK

Success.

E_INVALIDARG

Invalid method parameter.

E_FAIL

Other failure. For more information, call GetLastError.

Remarks

Because SipGetSupportedInputLanguages does not require the SIP environment to be loaded to successfully enumerate the input methods, calling it does not initialize the SIP environment. The SIP is initialized by the first function called that needs a loaded input environment. All SIP functions initialize the SIP environment except SipEnumIM, SipStatus, SipSetDefaultRect, SipRegisterNotification, and SipGetSupportedInputLanguages.

Requirements

Header

sipapi.h

Library

coredll.lib

sysgen

SYSGEN_SOFTKB

See Also

Reference

Software-based Input Panel Functions
SipEnumIM
SipGetSupportedInputLanguages
SipRegisterNotification
SipSetDefaultRect
SipStatus