Share via


PHOnHookDialing (Windows Embedded CE 6.0)

1/6/2010

This function tells the IP Dialer sample application to go off hook and place the requested character in the "to be dialed" pane. When talking about a virtual or real phone handset, "Off Hook" means that the "handset" button is not pressed, while "On Hook" means that the "handset" button on the phone is pressed down.

This API is called from the IP Home Screen sample application when the user starts dialing a call while the device is still "on-hook."

Syntax

HRESULT  PHOnHookDialing(
    const WCHAR CurrentChar
);

Parameters

  • CurrentChar
    [in] The current character to be dialed.

Return Value

The function returns an HRESULT indicating if the call succeeded or failed. The following table shows additional possible return values.

Value Description

E_FAIL

Failure.

E_INVALIDARG

The character passed is not between '0' and '9'.

Remarks

Note

This documentation applies to functionality implemented in sample code for PhCommon. For more information, see PhCommon Reference.

This function calls phonecore.dll, which is part of the IP Dialer, a component of the sample code, IP Phone Suite. It calls the OnHookDialing API exposed by phonecore.dll. Both PHMakePhoneCall and PHOnHookDialing are remote APIs which proxy into the phone application. They simply send the data structures to the running instance of the phone app, IP Dialer, via phonecore.dll.

Requirements

Header phoneapi.hpp
Library PhCommon.dll
Windows Embedded CE Windows Embedded CE 6.0 and later

See Also

Reference

PhCommon Phone APIs
PhCommon Reference