2.2.4.1.6.7 GetID

The GetID packet is transmitted from a TAPI client to a TAPI server in a remote procedure call. Sending this packet MUST return a device identifier for the particular device class that is associated with the specified phone device.

Req_Func (4 bytes): The identifier of the function that will be invoked on the remote server. This value MUST be set to 99.

Return Values

On completion of ClientRequest, this field MUST contain the result of the encapsulated telephony request. A value of 0 indicates success, and a PHONEERR_Constants value indicates failure. The remote server MUST complete this call synchronously.

Returns 0 if the request succeeds or a negative error number if an error occurs. The following table lists common return values.

Name	Value
PHONEERR_INVALPHONEHANDLE	0x00000013
PHONEERR_NOMEM	0x0000001A
PHONEERR_INVALPOINTER	0x00000015
PHONEERR_RESOURCEUNAVAIL	0x0000001F
PHONEERR_INVALDEVICECLASS	0x0000000D
PHONEERR_UNINITIALIZED	0x00000022
PHONEERR_OPERATIONFAILED	0x0000001C
PHONEERR_STRUCTURETOOSMALL	0x00000021
PHONEERR_OPERATIONUNAVAIL	0x0000001D

Reserved1 (4 bytes): An unsigned 32-bit integer. MUST be set to zero when sent and MUST be ignored on receipt.

hPhone (4 bytes): An HPHONE. The handle to an open phone device. This field MUST have been obtained by sending the Open packet.

lpDeviceID (4 bytes): An unsigned 32-bit integer. The size, in bytes, of a VARSTRING packet that contains the device identifier on successful completion of the request.

On successful completion, this field contains the offset, in bytes, of the packet in the VarData field.

lpszDeviceClass (4 bytes): An unsigned 32-bit integer. The offset in the VarData field that contains a null-terminated Unicode string that specifies the device class of the device whose identifier is requested.

Reserved2 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.

Reserved3 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.

Reserved4 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.

Reserved5 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.

Reserved6 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.

Reserved7 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.

Reserved8 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.

Reserved9 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.

Reserved10 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.

Reserved11 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.

VarData (variable): MUST contain a null-terminated Unicode string as specified in the lpszDeviceClass field. On successful completion, this field MUST also contain a VARSTRING packet as specified in the lpDeviceID field.

The contents of this field are DWORD-aligned.