Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This function enumerates the currently available input methods (IMs).

Syntax 

int SipEnumIM( 
  IMENUMPROC 
pEnumIMProc
);

Parameters

pEnumIMProc

[in] Pointer to the SipEnumIMProccallback function that receives information about the available IMs. Setting this parameter to NULL returns the number of available IMs.

Return Value

The number of available IMs. Zero indicates that no IMs are available. For Windows CE 3.0 and later, -1 indicates an error.

Remarks

For each IM, this function retrieves information about that IM and passes it to the function pointed to by the pEnumIMProcparameter. The application-defined callback function can process the IM information as desired. Enumeration continues until there are no more IMs or the callback function returns zero.

This function does not require that the software-based input panel environment be loaded in order to successfully enumerate the IMs. Therefore, a call to SipEnumIMdoes not initialize the software-based input panel environment. The software-based input panel environment is initialized by the first function called that needs a loaded input environment. All software-based input panel functions initialize the software-based input panel environment except SipEnumIM, SipStatus, SipSetDefaultRect, and SipRegisterNotification.

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