SipSetCurrentIM

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function sets the class identifier (CLSID) for the current input method (IM).

Syntax

BOOL SipSetCurrentIM( 
  CLSID* pClsid
);

Parameters

  • pClsid
    [in] Pointer to the buffer that contains that contains the CLSID of the new IM.

Return Value

TRUE indicates success. FALSE indicates failure. For more specific failure information, call GetLastError to get an HRESULT error code.

If the software-based input panel is unable to load the IM, the default IM is loaded in its place. Follow a call to SipSetCurrentIM with a call to SipGetCurrentIM to verify that the requested IM is loaded.

Remarks

An IM is a COM object; therefore, it is a window class defined by the application developer.

SipGetCurrentIM returns the CLSID of the active IM.

Requirements

Header sipapi.h
Library coredll.lib
Windows Embedded CE Windows CE 2.10 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

SipGetCurrentIM