dispGetRTCAliases

Returns a list of RTC aliases that are registered on the Natural Access context.

Prototype

DWORD dispGetRTCAliases (CTAHD ctahd, unsigned maxAliases, RTC_ALIAS aliases[], unsigned *pnumAliases )

Argument

Description

ctahd

Handle to a Natural Access context.

maxAliases

Maximum number of entries in the aliases array.

aliases

Pointer to the RTC_ALIAS array, defined as:

typedef struct
{
  DWORD EventID;                /* RTC condition event */
  char  Alias[ RTC_NAME_LEN ];  /* ASCII name          */  
}  RTC_ALIAS;

pnumAliases

Returned number of entries in the aliases array


Return values

Return value

Description

SUCCESS

 

CTAERR_BAD_ARGUMENT

aliases is NULL.

CTAERR_INVALID_CTAHD

Specified ctahd is invalid.

CTAERR_NOT_INITIALIZED

Natural Access is not initialized.

CTAERR_SVR_COMM

Natural Access Server is not running.


Details

dispGetRTCAliases returns a list of RTC condition aliases that are registered with RTC on the specified context. Call dispGetNumRTCAliases to determine the amount of space that needs to be allocated for the return buffer (aliases).

See also

dispRegisterRTCAlias, dispUnregisterRTCAlias