SipShowIM (Windows Embedded CE 6.0)

  • Article

1/6/2010

This function shows or hides the currently active software-based input panel window. An application must call this function to display the software-based input panel and its current input method.

Syntax

BOOL SipShowIM( 
  DWORD dwFlag
);

Parameters

  • dwFlag
    [in] Specifies whether to show or hide the current software-based input panel window. The following table shows the possible flags; it is one of the following flags.

    Value Description

    SIPF_ON

    Shows the software-based input panel window.

    SIPF_OFF

    Hides the software-based input panel window.

Return Value

TRUE indicates success. When this function fails, it returns an HRESULT error code.

Remarks

When this function is called, the software-based input panel notifies the input method (IM) of the appropriate action to take, which is whether to adopt a hidden or visible state.

On devices that have a limited display area, an application can call SipShowIM to hide the software-based input panel and increase the display area for output.

Requirements

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

See Also

Other Resources

Software-based Input Panel Functions