ASPEN_SessionFailureNotice

 

Related Topics

 

 

Purpose

Inform the application that a particular session has failed unexpectedly.

 

 

Notice

For this event notice, the notice parameter of the AspenEvent() function receives a pointer to an ASPEN_SESSION_FAILURE_NOTICE structure.

 

This structure is dynamically allocated by Aspen and must be freed using the AspenFreeMemory() function after use.

 

 

Structure

typedef struct

{

   int session;

   char errorTag[16];

   char errorText[80];

}ASPEN_SESSION_FAILURE_NOTICE;

 

 

Remarks

The ASPEN_SessionFailureNotice event is reported if a session fails unexpectedly (i.e., is terminated) due to some external cause.

 

This event will not be reported until all other pending events (such as instrument updates) pertaining to the indicated session have been reported and the request cycles for all outstanding service requests on the session have been completed.

 

An ASPEN_CloseSession service request used to close a normal, open session will not trigger this event

 

A terminated or failed session need not be formally closed using the ASPEN_CloseSession service.

 

 

See Also

AspenEvent()

ASPEN_SESSION_FAILURE_NOTICE

AspenFreeMemory()

Events

 

 

Example

NA

 

©2006 Aspen Research Group, Ltd. All rights reserved. Terms of Use.