lineGetAgentStatus

The lineGetAgentStatus function obtains the agent-related status on the specified address.

LONG lineGetAgentStatus(

HLINE hLine,
DWORD dwAddressID,
LPLINEAGENTSTATUS lpAgentStatus
);

Parameters
hLine

A handle to the open line device.

dwAddressID

The address on the open line device whose agent status is to be queried.

lpAgentStatus

A pointer to a variably sized structure of type LINEAGENTSTATUS. Upon successful completion of the request, this structure is filled with agent status information. Prior to calling lineGetAgentStatus, the application should set the dwTotalSize field of this structure to indicate the amount of memory available to TAPI for returning information.

Return Values
Returns a positive request identifier if the asynchronous operation starts; otherwise, one of these negative error values:

LINEERR_INVALADDRESSID, LINEERR_INVALLINEHANDLE, LINEERR_INVALPOINTER, LINEERR_NOMEM, LINEERR_OPERATIONFAILED, LINEERR_OPERATIONUNAVAIL, LINEERR_RESOURCEUNAVAIL, LINEERR_STRUCTURETOOSMALL, LINEERR_UNINITIALIZED.