ASPEN_CloseSession

 

Related Topics

 

 

Purpose

Terminate an open session with a Server.

 

 

Call Syntax

#include <aspen.h>

AspenRequest(GLOBAL_session, ASPEN_CloseSession, NULL, NULL);

 

 

Parameters

None. Pass NULL to both the input and output parameters.

 

 

Structures

None.

 

 

Remarks

ASPEN_CloseSession closes an open session, terminating all communications with the Server.

 

When closing a validated session, the session is automatically invalidated before closure. The effect is the same as if the ASPEN_InvalidateSession service had been requested before the ASPEN_CloseSession request, only the entire process completes in a single step.

 

 

Return Value

ASPEN_OK

Session closed successfully.

ASPEN_FN_SSN_NOT_OPEN

No open session exists.

 

 

See Also

ASPEN_OpenSession

ASPEN_ValidateSession

ASPEN_InvalidateSession

AspenRequest()

 

 

Example

int DoASPEN_CloseSession()

{

   server_list       *slp = list;

   int               service;

   int               retval;

   void              *input;

   void              *output;

   service = ASPEN_CloseSession;

   input = NULL;

   output = NULL;

   retval = AspenRequest(

            slp->server_session,

            service,

            &input,

            &output);

   return retval;

}

 

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