phoneGetID

Windows Mobile 6.5
A version of this page is also available for
4/8/2010

This function returns a device identifier for the given device class associated with the specified phone device.


LONG WINAPI phoneGetID(
  HPHONE hPhone,
  LPVARSTRING lpDeviceID,
  LPCWSTR lpszDeviceClass 
);

hPhone

Handle to an open phone device.

lpDeviceID

Pointer to a data structure of type VARSTRING where the device identifier is returned. Upon successful completion of the request, this location is filled with the device identifier. The format of the returned information depends on the method used by the device class (API) for naming devices.

lpszDeviceClass

Pointer to a null-terminated string that specifies the device class of the device whose identifier is requested. The device class is dependent on the service provider.

Returns zero if the request succeeds or a negative error number if an error occurs. The following table shows the return values for this function.

Value Description

PHONEERR_INVALPHONEHANDLE

The handle to the open phone device is invalid.

PHONEERR_NOMEM

Not enough memory is available.

PHONEERR_INVALPOINTER

The pointer is invalid.

PHONEERR_RESOURCEUNAVAIL

The resources are unavailable.

PHONEERR_INVALDEVICECLASS

The device class is invalid.

PHONEERR_UNINITIALIZED

A parameter is uninitialized.

PHONEERR_OPERATIONFAILED

The operation failed.

PHONEERR_STRUCTURETOOSMALL

The structure is too small.

PHONEERR_OPERATIONUNAVAIL

The operation is unavailable.

The phoneGetID function can be used to retrieve a phone device identifier given a phone handle. It can also be used to obtain the device identifier of the media device (for device classes such as COM, wave, MIDI, phone, line, or NDIS) associated with the opened phone device. The names of these device classes are not case sensitive. This identifier can then be used with the appropriate media API to select the corresponding device.

See TAPI Device Classes for device class names.

A vendor that defines a device-specific media type also needs to define the corresponding device-specific (proprietary) API to manage devices of the media type. To avoid collisions on device class names assigned independently by different vendors, a vendor should select a name that uniquely identifies both the vendor and, following it, the media type. For example: "Intel/video".

Aa920253.note(en-us,MSDN.10).gifNote:
This function is for TAPI version 2.0 and later.

Headertapi.h
Librarycoredll.lib
Windows Embedded CEWindows CE 3.0 and later
Windows MobileWindows Mobile Version 5.0 and later

Community Additions

Show: