dtmRefreshTrunkStatus

Requests a status event from the board.

Prototype

DWORD dtmRefreshTrunkStatus ( DTMHD dtmhd)

Argument

Description

dtmhd

Handle to the trunk monitor object.


Return values

Return value

Description

SUCCESS

 

CTAERR_INVALID_HANDLE

dtmhd is not a valid monitor handle.

CTAERR_SVR_COMM

Communication error in server environment.


Events

Event

Description

DTMEVN_TRUNK_STATUS

The value field contains a 4-byte DTM_TRUNK_STATE structure. When the trunk is operational, all bytes are set to 0. The objHd field contains the dtmhd.


Details

dtmRefreshTrunkStatus sends a request to the board to report the current alarm status. The board sends a trunk status event immediately upon receiving this request. Use dtmGetTrunkStatus to retrieve the updated trunk status.

Note: dtmSendAlarm is not used with BRI trunks.