GetSIPType

Description

Returns the type of the current SIP window, whether it is visible or not.

Syntax

SIPIMType GetSIPType ( )

Argument

Description

SIPIMType

An enumerated representation of the type of SIP. Supported values are: SIPKeyboard!, SIPBlock!, SIPJot!, SIPWordLogic!, SIPTranscriber!, and SIPFitaly!

Returns

SIPIMType. Returns -1 for failure. On the desktop, always returns SIPKeyboard! for the SIPIMType.

Usage

You can use this method to report the current SIP input method available to the application user.

Examples

Example 1

The following example displays the type of the current SIP window in a multiline edit text box:

String strDisplay=""

SIPIMType sType 
sType = GetSIPType()

choose case sType	
   case SIPKeyboard!
		strDisplay += ("SIP TYPE IS Keyboard! ~r~n")
   case SIPJot!
		strDisplay += ("SIP TYPE IS SIPJot! ~r~n")
   case SIPBlock!
		strDisplay += ("SIP TYPE IS SIPBlock! ~r~n")
   case SIPWordLogic!
		strDisplay += ("SIP TYPE IS SIPWordLogic! ~r~n")
   case SIPTranscriber!
		strDisplay +=("SIP TYPE IS SIPTranscriber! ~r~n")

	case SIPFitaly!
		strDisplay +=("SIP TYPE IS Fitaly keyboard ~r~n")

	case else	
       	strDisplay+= ("ERROR!!! INVALID SIP TYPE ~r~n");
end choose

mle_1.text = strDisplay

See also