Partager via

lineSetStatusMessages (Compact 2013)

  • Article

3/26/2014

This function enables an application to specify which notification messages the application wants to receive for events related to status changes for the specified line or any of its addresses.

Syntax

LONG lineSetStatusMessages(
  HLINE hLine, 
  DWORD dwLineStates, 
  DWORD dwAddressStates
);

Parameters

  • hLine
    [in] Handle to the line device.
  • dwLineStates
    [in] Value that specifies for which line-device status changes a message is to be sent to the application. This parameter uses LINEDEVSTATE.
  • dwAddressStates
    [in] Value that specifies for which address status changes a message is to be sent to the application. This parameter uses LINEADDRESSSTATE.

Return Value

Zero indicates success. A negative error number indicates that an error occurred. The following table shows the return values for this function.

Value

Description

LINEERR_INVALADDRESSSTATE

The address state is invalid.

LINEERR_INVALLINEHANDLE

The line handle is invalid.

LINEERR_INVALLINESTATE

The line state is invalid.

LINEERR_NOMEM

Not enough memory is available.

LINEERR_OPERATIONFAILED

The operation failed.

LINEERR_OPERATIONUNAVAIL

The operation is unavailable.

LINEERR_RESOURCEUNAVAIL

The resource is unavailable.

LINEERR_UNINITIALIZED

A parameter is uninitialized.

Remarks

TAPI defines a number of messages that notify applications about events occurring on lines and addresses. An application may not be interested in receiving all address and line status change messages. The lineSetStatusMessages function can be used to select which messages the application receives. By default, address and line status reporting is disabled.

Requirements

Header

tapi.h

Library

TAPI32.dll

See Also

Reference

TAPI Line Device Functions
lineInitialize
lineOpen
LINE_CLOSE (TAPI)
LINE_LINEDEVSTATE (TAPI)