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

MQe_ListCertificates.h File Reference

The ListCertificates class C API header file for Java bindings. More...


Functions

MQERETURN mqeListCertificate_new (MQeExceptBlock *pErrStruct, MQeListCertificateHndl *phListCertificate, MQeStringHndl hName, MQeFieldsHndl hRegParams)
 Constructs an MQeListCertificate object.

MQERETURN mqeListCertificate_activate (MQeListCertificateHndl hListCertificate, MQeExceptBlock *pErrStruct, MQeStringHndl hName, MQeFieldsHndl hRegParams)
 Activate the configuration by opening the registry.

MQERETURN mqeListCertificate_readAllEntries (MQeListCertificateHndl hListCertificate, MQeExceptBlock *pErrStruct, MQeFieldsHndl *phEntries)
 read all the certificate entries in the registry

MQERETURN mqeListCertificate_readEntry (MQeListCertificateHndl hListCertificate, MQeExceptBlock *pErrStruct, MQeFieldsHndl *phEntry, MQeStringHndl hCertName)
 read a specified certificate entry in the registry

MQERETURN mqeListCertificate_getWTLSCertificate (MQeListCertificateHndl hListCertificate, MQeExceptBlock *pErrStructMQeFields, MQeCertificateHndl *phCertificate, MQeFieldsHndl hEntry)
 Get the certificate from the registry entry.

MQERETURN mqeListCertificate_isNewCertificate (MQeListCertificateHndl hListCertificate, MQeExceptBlock *pErrStructMQeFields, MQEBOOL *pIsNew, MQeCertificateHndl hCertificate)
 Return the certificate style.

MQERETURN mqeListCertificate_getSubject (MQeListCertificateHndl hListCertificate, MQeExceptBlock *pErrStructMQeFields, MQeStringHndl *phSubject, MQeCertificateHndl hCertificate)
 Return the subject field from the certificate.

MQERETURN mqeListCertificate_getIssuer (MQeListCertificateHndl hListCertificate, MQeExceptBlock *pErrStructMQeFields, MQeStringHndl *phIssuer, MQeCertificateHndl hCertificate)
 Return the issuer field from the certificate.

MQERETURN mqeListCertificate_getNotBefore (MQeListCertificateHndl hListCertificate, MQeExceptBlock *pErrStructMQeFields, MQEINT64 *pNotBeforeDate, MQeCertificateHndl hCertificate)
 Return the "Valid not before" date from the certificate.

MQERETURN mqeListCertificate_getNotAfter (MQeListCertificateHndl hListCertificate, MQeExceptBlock *pErrStructMQeFields, MQEINT64 *pNotAfterDate, MQeCertificateHndl hCertificate)
 Return the "Valid not after" date from the certificate.

MQERETURN mqeListCertificate_close (MQeListCertificateHndl hListCertificate, MQeExceptBlock *pErrStructMQeFields)
 Closes the mqeListCertificate.

MQERETURN mqeListCertificate_free (MQeListCertificateHndl hListCertificate, MQeExceptBlock *pErrStructMQeFields)


Detailed Description

This page describes MQe_ListCertificates C API prototypes.


Function Documentation

MQERETURN mqeListCertificate_new MQeExceptBlock   pErrStruct,
MQeListCertificateHndl *    phListCertificate,
MQeStringHndl    hName,
MQeFieldsHndl    hRegParams
 

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
phListCertificate  [out] Pointer to handle for output
hName  [in] The registry name
hRegParams  [in] Registry initialization parameters
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
phListCertificate must not be NULL.
Returns :
A new MQeListCertificate object handle is created and returned via phListCertificate
Warning:
Users are expected to use mqeListCertificate_free() to free the object returned by this call when it is no longer needed. This enables reuse of system resources and can help to avoid system problems caused by shortage of resources.
Return values:
MQERETURN_OK  Completed Successfully

MQERETURN mqeListCertificate_activate MQeListCertificateHndl    hListCertificate,
MQeExceptBlock   pErrStruct,
MQeStringHndl    hName,
MQeFieldsHndl    hRegParams
 

Parameters:
hListCertificate  [in] Handle for the MQeListCertificate to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hName  [in] Registry name
hRegParams  [in] MQeFields object containing startup parameters
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK  Completed Successfully

MQERETURN mqeListCertificate_readAllEntries MQeListCertificateHndl    hListCertificate,
MQeExceptBlock   pErrStruct,
MQeFieldsHndl *    phEntries
 

Parameters:
hListCertificate  [in] Handle for the MQeListCertificate to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
phEntries  [in/out] Pointer to the handle for output
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Returns :
in (*phEntries)
Return values:
MQERETURN_OK  Completed Successfully

MQERETURN mqeListCertificate_readEntry MQeListCertificateHndl    hListCertificate,
MQeExceptBlock   pErrStruct,
MQeFieldsHndl *    phEntry,
MQeStringHndl    hCertName
 

Parameters:
hListCertificate  [in] Handle for the MQeListCertificate to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
phEntriy  [in/out] Pointer to the handle for output
hCertName  [in] Name of the certificate to read from the registry
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Returns :
in (*phEntriy)
Return values:
MQERETURN_OK  Completed Successfully

MQERETURN mqeListCertificate_getWTLSCertificate MQeListCertificateHndl    hListCertificate,
MQeExceptBlock   pErrStructMQeFields,
MQeCertificateHndl *    phCertificate,
MQeFieldsHndl    hEntry
 

Parameters:
hListCertificate  [in] Handle for the MQeListCertificate to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
phCertificate  [in/out] Pointer to the handle for output
hEntry  [in] Registry entry
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Returns :
in (*phCertificate)
Return values:
MQERETURN_OK  Completed Successfully

MQERETURN mqeListCertificate_isNewCertificate MQeListCertificateHndl    hListCertificate,
MQeExceptBlock   pErrStructMQeFields,
MQEBOOL *    pIsNew,
MQeCertificateHndl    hCertificate
 

Parameters:
hListCertificate  [in] Handle for the MQeListCertificate to be operated on.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
pIsNew  [in/out] Pointer to the handle for output.
hCertificate  [in] The certificate object from the registry.
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Returns :
in (*pIsNew)
Return values:
MQERETURN_OK  Completed Successfully

MQERETURN mqeListCertificate_getSubject MQeListCertificateHndl    hListCertificate,
MQeExceptBlock   pErrStructMQeFields,
MQeStringHndl *    phSubject,
MQeCertificateHndl    hCertificate
 

Parameters:
hListCertificate  [in] Handle for the MQeListCertificate to be operated on.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
phSubject  [in/out] Pointer to the handle for output.
hCertificate  [in] The certificate object from the registry.
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Returns :
in (*phSubject)
Return values:
MQERETURN_OK  Completed Successfully

MQERETURN mqeListCertificate_getIssuer MQeListCertificateHndl    hListCertificate,
MQeExceptBlock   pErrStructMQeFields,
MQeStringHndl *    phIssuer,
MQeCertificateHndl    hCertificate
 

Parameters:
hListCertificate  [in] Handle for the MQeListCertificate to be operated on.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
phIssuer  [in/out] Pointer to the handle for output.
hCertificate  [in] The certificate object from the registry.
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Returns :
in (*phIssuer)
Return values:
MQERETURN_OK  Completed Successfully

MQERETURN mqeListCertificate_getNotBefore MQeListCertificateHndl    hListCertificate,
MQeExceptBlock   pErrStructMQeFields,
MQEINT64 *    pNotBeforeDate,
MQeCertificateHndl    hCertificate
 

Parameters:
hListCertificate  [in] Handle for the MQeListCertificate to be operated on.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
pNotBeforeDate  [in/out] Pointer to the handle for output.
hCertificate  [in] The certificate object from the registry.
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Returns :
in (*pNotBeforeDate)
Return values:
MQERETURN_OK  Completed Successfully
Note:
This is returned as the number of seconds since 1st Jan 1970 (standard UNIX format). -1 is returned if it is not a valid certificate object.

MQERETURN mqeListCertificate_getNotAfter MQeListCertificateHndl    hListCertificate,
MQeExceptBlock   pErrStructMQeFields,
MQEINT64 *    pNotAfterDate,
MQeCertificateHndl    hCertificate
 

Parameters:
hListCertificate  [in] Handle for the MQeListCertificate to be operated on.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
pNotAfterDate  [in/out] Pointer to the handle for output.
hCertificate  [in] The certificate object from the registry.
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Returns :
in (*pNotAfterDate)
Return values:
MQERETURN_OK  Completed Successfully
Note:
This is returned as the number of seconds since 1st Jan 1970 (standard UNIX format). -1 is returned if it is not a valid certificate object.

MQERETURN mqeListCertificate_close MQeListCertificateHndl    hListCertificate,
MQeExceptBlock   pErrStructMQeFields
 

Parameters:
hListCertificate  [in] Handle for the MQeListCertificate to be operated on.
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  Completed Successfully

MQERETURN mqeListCertificate_free MQeListCertificateHndl    hListCertificate,
MQeExceptBlock   pErrStructMQeFields
 

Frees the mqeListCertificate handle

Parameters:
hListCertificate  [in] Handle for the MQeListCertificate to be operated on.
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  Completed Successfully


Generated Thu Aug 11 23:41:19 2005 for Websphere MQ Everyplace for Multiplatforms C Bindings Reference