dispRegisterRTCAlias

Defines an alias associated with service-specific events. This alias can then be used by other services as an identifier of an RTC condition.

Prototype

DWORD dispRegisterRTCAlias (CTAHD ctahd, RTC_ALIAS *alias )

Argument

Description

ctahd

Handle to a Natural Access context.

alias

Pointer to the RTC_ALIAS array, defined as:

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


Return values

Return value

Description

SUCCESS

 

CTAERR_BAD_ARGUMENT

alias is NULL, alias contains a zero length Alias string, or the EventID is not a valid service event.

CTAERR_INVALID_CTAHD

Specified ctahd is invalid.

CTAERR_NOT_INITIALIZED

Natural Access is not initialized.

CTAERR_OUT_OF_MEMORY

Unable to allocate memory for the RTC_ALIAS structure.

CTAERR_SVR_COMM

Natural Access Server is not running.


Details

dispRegisterRTCAlias creates an association between the RTC condition and the specified ASCII alias name and records it within the dispatcher's RTC database. The same name can be assigned to multiple service events.

To receive RTC notification whenever an event in the alias group occurs, a consumer service uses dispAddRTC to register the alias as a condition and associate an action with it. Then when an event associated with an alias occurs, the dispatcher notifies any consumer services registered with the alias.

See also

dispUnregisterRTCAlias