TSPI_phoneSelectExtVersion (Compact 2013)
3/26/2014
This function selects the indicated extension version for the indicated phone device. Subsequent requests operate according to that extension version.
Syntax
LONG TSPIAPI TSPI_phoneSelectExtVersion(
HDRVPHONE hdPhone,
DWORD dwExtVersion
);
Parameters
- hdPhone
Handle to the phone for which an extension version is to be selected.
- dwExtVersion
Extension version to be selected. This version number is negotiated using the TSPI_phoneNegotiateExtVersion function. The most-significant WORD is the major version number and the least-significant WORD is the minor version number. Calling this function with a dwExtVersion of zero cancels the current selection.
Return Value
Returns zero if the function succeeds, or an error number if an error occurs. The following table shows the return values for this method.
Value |
Description |
|---|---|
PHONEERR_INCOMPATIBLEEXTVERSION |
The extension version is incompatible. |
PHONEERR_OPERATIONFAILED |
The operation failed. |
PHONEERR_NOMEM |
Not enough memory is available. |
PHONEERR_OPERATIONUNAVAIL |
The operation is unavailable. |
PHONEERR_RESOURCEUNAVAIL |
The resource is unavailable. |
Remarks
This function selects the indicated extension version. Although the indicated version number may have been successfully negotiated, a different extension version may have been selected in the interim, in which case this function fails (returning PHONEERR_INCOMPATIBLEEXTVERSION).
Subsequent operations on the phone after an extension version is selected behave according to that extension version. Subsequent attempts to negotiate the extension version report strictly the selected version or zero (if the requested range does not include the selected version). Calling this procedure with the special extension version zero cancels the current selection. The device once again becomes capable of supporting its full range of extension version numbers.
TSPI_phoneSelectExtVersion is typically called in two situations: (1) An application requested to open a phone, the application requested that a particular extension version be used, and no extension version was currently selected; or (2) the last application using a particular extension version closed the phone, and the extension version selection can be canceled.
Requirements
Header |
tspi.h |
Library |
CellTSP.dll |