Skip to content

Latest commit

 

History

History
102 lines (74 loc) · 3.42 KB

nf-tapi-linegetmessage.md

File metadata and controls

102 lines (74 loc) · 3.42 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.lineGetMessage
lineGetMessage function (tapi.h)
The lineGetMessage function returns the next TAPI message that is queued for delivery to an application that is using the Event Handle notification mechanism (see lineInitializeEx for further details).
_tapi2_linegetmessage
lineGetMessage
lineGetMessage function [TAPI 2.2]
tapi/lineGetMessage
tapi2.linegetmessage
tapi2\linegetmessage.htm
tapi3
ed6df53e-b01d-40bc-8676-b0f7e0eacfd1
12/05/2018
_tapi2_linegetmessage, lineGetMessage, lineGetMessage function [TAPI 2.2], tapi/lineGetMessage, tapi2.linegetmessage
tapi.h
Windows
Tapi32.lib
Tapi32.dll
Windows
19H1
lineGetMessage
tapi/lineGetMessage
c++
APIRef
kbSyntax
DllExport
Tapi32.dll
lineGetMessage

lineGetMessage function

-description

The lineGetMessage function returns the next TAPI message that is queued for delivery to an application that is using the Event Handle notification mechanism (see lineInitializeEx for further details).

-parameters

-param hLineApp

Handle returned by lineInitializeEx. The application must have set the LINEINITIALIZEEXOPTION_USEEVENT option in the dwOptions member of the LINEINITIALIZEEXPARAMS structure.

-param lpMessage

Pointer to a LINEMESSAGE structure. Upon successful return from this function, the structure contains the next message that had been queued for delivery to the application.

-param dwTimeout

Time-out interval, in milliseconds. The function returns if the interval elapses, even if no message can be returned. If dwTimeout is zero, the function checks for a queued message and returns immediately. If dwTimeout is INFINITE, the function's time-out interval never elapses.

-returns

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

LINEERR_INVALAPPHANDLE, LINEERR_OPERATIONFAILED, LINEERR_INVALPOINTER, LINEERR_NOMEM.

-remarks

If the lineGetMessage function has been called with a non-zero timeout and the application calls lineShutdown on another thread, this function returns immediately with LINEERR_INVALAPPHANDLE.

If the timeout expires (or was zero) and no message could be fetched from the queue, the function returns with the error LINEERR_OPERATIONFAILED.

-see-also

LINEINITIALIZEEXPARAMS

LINEMESSAGE

lineInitializeEx

lineShutdown