ITPhone::Close method (tapi3if.h)

The Close method closes this phone device. The phone device remains closed until the application calls the ITPhone::Open method. For more information, see the following Remarks section.

This method is analogous to the TAPI 2.x phoneOpen function; please see the TAPI 2.x documentation for more information.

Syntax

HRESULT Close();

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

While a phone is closed, the application does not receive events pertaining to the phone.

A phone must be open with owner privilege for the application to set the state of the phone. Querying the state of the phone can typically be done even if the phone is not open; for more details, see the individual methods of the ITPhone interface.

After the phone device has been successfully closed, any ITAutomatedPhoneControl interface pointer obtained for this phone object is no longer valid.

Requirements

Requirement Value
Target Platform Windows
Header tapi3if.h (include Tapi3.h)
Library Uuid.lib
DLL Tapi3.dll

See also

ITPhone