This function enumerates the currently available input methods (IMs).
At a Glance
| Header file: | Sipapi.h |
| Windows CE versions: | 2.10 and later |
Syntax
int SipEnumIM( IMENUMPROC pEnumIMProc);
Parameters
pEnumIMProc
[in] Pointer to the SipEnumIMProc callback function that receives information about the available IMs. Setting this parameter to NULL returns the number of available IMs.
Return Values
The number of available IMs. Zero indicates that no IMs are available.
Remarks
For each IM, the SipEnumIM function retrieves information about that IM and passes it to the function pointed to by the pEnumIMProc parameter. 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.
SipEnumIM does not require that the input panel environment be loaded in order to successfully enumerate the IMs. Therefore, a call to SipEnumIM does not initialize the input panel environment. The input panel environment is initialized by the first function called that needs a loaded input environment. All input panel functions initialize the input panel environment except SipEnumIM, SipStatus, SipSetDefaultRect, and SipRegisterNotification.
See Also