ITAddress::get_MessageWaiting method (tapi3if.h)

The get_MessageWaiting method determines if the address has a message waiting.

Syntax

HRESULT get_MessageWaiting(
  [out] VARIANT_BOOL *pfMessageWaiting
);

Parameters

[out] pfMessageWaiting

If VARIANT_TRUE is returned, a message is waiting; if VARIANT_FALSE is returned, no message is waiting.

Return value

This method can return one of these values.

Return code Description
S_OK
Method succeeded.
E_OUTOFMEMORY
Insufficient memory exists to perform the operation.
E_POINTER
The pfMessageWaiting parameter is not a valid pointer.

Remarks

In TAPI 2.x, this maps to the flag LINEDEVSTATUSFLAGS_MSGWAIT being set or not in the member dwDevStatusFlags from the structure LINEDEVSTATUS.

Requirements

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

See also

Address Object

ITAddress

LINEDEVSTATUS

put_MessageWaiting