Share via

SipShowIM (Compact 2013)

  • Article

3/28/2014

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

Syntax

BOOL SipShowIM( 
  DWORD dwFlag
);

Parameters

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

    Value

    Description

    SIPF_ON

    Shows the SIP window.

    SIPF_OFF

    Hides the SIP window.

Return Value

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

Remarks

When this function is called, the SIP notifies the input method 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 SIP and increase the display area for output.

Requirements

Header

sipapi.h

Library

coredll.lib

sysgen

SYSGEN_SOFTKB

See Also

Reference

Software-based Input Panel Functions