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

MQe_Authenticator.h File Reference


Detailed Description

API header file for MQe Authenticator.


Functions

MQERETURN mqeAuthenticator_new (MQeExceptBlock *pErrStruct, MQeAuthenticatorHndl *phNewAuthenticator, MQeStringHndl hToken)
 creates a new authenticator.

MQERETURN mqeAuthenticator_free (MQeAuthenticatorHndl hAuthenticator, MQeExceptBlock *pErrStruct)
 polymorphic API for freeing an authenticator.

MQERETURN mqeAuthenticator_setAuthenticatedID (MQeAuthenticatorHndl hAuthenticator, MQeExceptBlock *pErrStruct, MQeStringHndl hID)
 sets an authenticator's id.

MQERETURN mqeAuthenticator_getPrivateData (MQeAuthenticatorHndl hAuthenticator, MQeExceptBlock *pErrStruct, MQEVOID **ppDataBlock)
 get the pointer to the subclass private data block.


Function Documentation

MQERETURN mqeAuthenticator_new MQeExceptBlock   pErrStruct,
MQeAuthenticatorHndl *    phNewAuthenticator,
MQeStringHndl    hToken
 

creates a new authenticator.

Parameters:
pErrStruct  [in/out] pointer to exception block.
phNewAuthenticator  [in/out] pointer to output handle variable.
hToken  [in] authenticator class alias
Precondition:
pErrStruct should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pErrStruct is NULL).
Returns :
output in *phNewAuthenticator.
Return values:
MQERETURN_OK 
  • Completed Sucessfully
MQERETURN_S_AUTHENTICATOR_PLUGININIT_FAIL 
  • plugin returned return code
MQERETURN_S_AUTHENTICATOR_NEW_FAIL 
  • MQEREASON_AUTHENTICATOR_ALLOC_FAIL failed to allocate memory
MQERETURN_S_AUTHENTICATOR_NEW_FAIL 
  • MQEREASON_AUTHENTICATOR_MODULERESOLVE_FAIL failed to resolve plugin module init function
MQERETURN_S_AUTHENTICATOR_NEW_FAIL 
  • MQEREASON_AUTHENTICATOR_MODULELOAD_FAIL failed to load plugin module
MQERETURN_S_AUTHENTICATOR_NEW_FAIL 
  • other error codes due to internal errors
other 
  • other common error codes caused by invalid supplied parameters
Warning:
Users are expected to use mqeAuthenticator_free() to free the object returned by this call after it is no longer needed. This will enable reuse of some system resources and avoid some avoidable system crashes.

MQERETURN mqeAuthenticator_free MQeAuthenticatorHndl    hAuthenticator,
MQeExceptBlock   pErrStruct
 

polymorphic API for freeing an authenticator.

Parameters:
hAuthenticator  [in] authenticator to be freed.
pErrStruct  [in/out] pointer to exception block.
Precondition:
pErrStruct should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pErrStruct is NULL).
Return values:
MQERETURN_OK 
  • Completed Sucessfully
MQERETURN_S_AUTHENTICATOR_PLUGINFREE_FAIL 
  • plugin returned return code
MQERETURN_S_AUTHENTICATOR_FREE_FAIL 
  • MQEREASON_AUTHENTICATOR_FREE_FAIL failed to free memory
MQERETURN_S_AUTHENTICATOR_FREE_FAIL 
  • other reason codes due to internal errors
other 
  • other common error codes caused by invalid supplied parameters

MQERETURN mqeAuthenticator_setAuthenticatedID MQeAuthenticatorHndl    hAuthenticator,
MQeExceptBlock   pErrStruct,
MQeStringHndl    hID
 

sets an authenticator's id.

Parameters:
hAuthenticator  [in] authenticator to be operated upon.
pErrStruct  [in/out] pointer to exception block.
hID  [in] ID to be used.
Precondition:
pErrStruct should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pErrStruct is NULL).
Return values:
MQERETURN_OK 
  • Completed Sucessfully
other 
  • other common error codes caused by invalid supplied parameters

MQERETURN mqeAuthenticator_getPrivateData MQeAuthenticatorHndl    hAuthenticator,
MQeExceptBlock   pErrStruct,
MQEVOID **    ppDataBlock
 

get the pointer to the subclass private data block.

Parameters:
hAuthenticator  [in] authenticator to be operated upon.
pErrStruct  [in/out] pointer to exception block.
ppDataBlock  [in/out] pointer to output pointer to the data block.
Precondition:
pErrStruct should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pErrStruct is NULL).
Return values:
MQERETURN_OK 
  • Completed Sucessfully
other 
  • other common error codes caused by invalid supplied parameters


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