Skip to content

Latest commit

 

History

History
83 lines (64 loc) · 2.55 KB

nf-tapi-phonegetgain.md

File metadata and controls

83 lines (64 loc) · 2.55 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:tapi.phoneGetGain
phoneGetGain function (tapi.h)
The phoneGetGain function returns the gain setting of the microphone of the specified phone's hookswitch device.
_tapi2_phonegetgain
phoneGetGain
phoneGetGain function [TAPI 2.2]
tapi/phoneGetGain
tapi2.phonegetgain
tapi2\phonegetgain.htm
tapi3
ea6ba2f0-ff79-41b8-9165-bb250077b2dc
12/05/2018
_tapi2_phonegetgain, phoneGetGain, phoneGetGain function [TAPI 2.2], tapi/phoneGetGain, tapi2.phonegetgain
tapi.h
Windows
Tapi32.lib
Tapi32.dll
Windows
19H1
phoneGetGain
tapi/phoneGetGain
c++
APIRef
kbSyntax
DllExport
Tapi32.dll
phoneGetGain

phoneGetGain function

-description

The phoneGetGain function returns the gain setting of the microphone of the specified phone's hookswitch device.

-parameters

-param hPhone

Handle to the open phone device.

-param dwHookSwitchDev

Hookswitch device whose gain level is queried. The dwHookSwitchDev parameter can have only one bit set. This parameter uses one and only one of the PHONEHOOKSWITCHDEV_ Constants.

-param lpdwGain

Pointer to a DWORD containing the current gain setting of the hookswitch microphone component. The dwGain parameter specifies the volume level of the hookswitch device. This is a number in the range 0x00000000 (silence) to 0x0000FFFF (maximum volume). The actual granularity and quantization of gain settings in this range are service provider-specific.

-returns

Returns zero if the request succeeds or a negative error number if an error occurs. Possible return values are:

PHONEERR_INVALPHONEHANDLE, PHONEERR_NOMEM, PHONEERR_INVALPOINTER, PHONEERR_RESOURCEUNAVAIL, PHONEERR_INVALPHONESTATE, PHONEERR_OPERATIONFAILED, PHONEERR_INVALHOOKSWITCHDEV, PHONEERR_UNINITIALIZED, PHONEERR_OPERATIONUNAVAIL.

-see-also

Supplementary Phone Service Functions

TAPI 2.2 Reference Overview