Main Page   Modules   Data Structures   File List   Data Fields   Globals   Related Pages  

MQe_Session.h File Reference


Detailed Description

The WebSphere MQ Everyplace Session class API header file.

This file describes MQeSession API prototypes.

Every application needs to start one (and only one) WebSphere MQ Everyplace session in order to access WebSphere MQ Everyplace functionality.


Functions

MQERETURN mqeSession_initialize (MQeExceptBlock *pErrStruct)
 This function initializes a WebSphere MQ Everyplace session.

MQERETURN mqeSession_terminate (MQeExceptBlock *pErrStruct)
 This function terminates a WebSphere MQ Everyplace session.


Function Documentation

MQERETURN mqeSession_initialize MQeExceptBlock   pErrStruct
 

This function initializes a WebSphere MQ Everyplace session.

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK 
  • MQEREASON_OK Operation successful
  • MQEREASON_SESSION_ALREADY_INITIALIZED Session already initialized
MQERETURN_ALLOCATION_FAIL 
  • Not enough heap space
Warning:
Users are expected to call mqeSession_terminate() after completing all WebSphere MQ Everyplace operations.

MQERETURN mqeSession_terminate MQeExceptBlock   pErrStruct
 

This function terminates a WebSphere MQ Everyplace session.

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK  Operation successful


Generated Thu Aug 11 23:27:12 2005 for Websphere MQ Everyplace for Multiplatforms C Programming Reference