dispGetActiveRTC

Returns a list of RTC conditions and actions that were added to the Natural Access context.

Prototype

DWORD dispGetActiveRTC (CTAHD ctahd, unsigned maxRTCs, RTC_CONDITION pconditions[], RTC_ACTION pactions[], unsigned *pnumRTCs )

Argument

Description

ctahd

Handle to a Natural Access context.

maxRTCs

Maximum number of entries in pconditions/pactions arrays.

pconditions

Pointer to the RTC_CONDITION array.

pactions

Pointer to the RTC_ACTION array.

pnumRTCs

Returned number of entries in pconditions/pactions arrays.


Return values

Return value

Description

SUCCESS

 

CTAERR_BAD_ARGUMENT

pnumRTCs, pconditions, or pactions is NULL, or maxRTCs is 0.

CTAERR_INVALID_CTAHD

The specified ctahd is invalid.

CTAERR_SVR_COMM

Natural Access Server is not running.


Details

dispGetActiveRTC returns a list of RTC conditions and associated actions that were added to the specified context. These arrays are parallel in that the same indexed entry is associated to one another. Call dispGetNumRTC to determine the amount of space that needs to be allocated for the return buffers (pconditions, pactions).

This function returns all pconditions/pactions arrays in the database, up to maxRTCs. This function cannot be used to iterate through the database.

See also

dispAddRTC