|
Developer's Guide
|
|
|
Developer's Guide
|
|
#include <p6kmipclient.h>
Each client request message sent to a KMIP server can contain one to several batch items (e.g., the locateAndGet() API call has 2 batch items, while the locateObject() API call has one). Each batch item is a request for the server to perform a separate operation (e.g., locateAndGet() first performs a Locate operation followed by a Get operation). Each separate batch item has its own P6KMIP_RESULT parameter returned containing the result of the operation.
The following fields: { timestamp, pNonceId, pNonceValue, pAttestationType } apply to an entire response, not just one batch item. These fields, if present, are always returned in the first P6KMIP_RESULT parameter returned in a multi-batch response. All other fields are relevant to the specific batch item.
resultStatus - can have one of the values from Section 9.1.3.2.28 in p6kmip.h, Result Status Enumeration indicating the result of the operation resultReason - can have one of the values from Section 9.1.3.2.29 in p6kmip.h, Result Reason Enumeration for more detailed error information, or zero if not set by server timestamp - timestamp of the response message pMessage - an enumerator holding a more descriptive error message which can be provided to an end user or for logging, or NULL if not set by server pAsynchCorrelation - if the server decides to execute the request in an asynchronous manner then this enumerator contains the Asynchronous Correlation Value to be used by the client in a Poll or Cancel request (see Section 6.8 KMIP spec) locatedItems - result of a Locate Operation, returns the number of items found by the locate, -1 returned by Locate if not set by server (added to KMIP 1.3)
- pNonceId & pNonceValue comprise the Nonce Object returned by the KMIP server to return a random value to the client (can be used in Attestation)
pNonceId - identifies the Nonce object on the server pNonceValue - random data created by the server pAttestationType - an enumerator of attestation types returned by server in an Attestation error message, see Section 9.1.3.2.36 Attestation Type Enumeration in p6kmip.h
Definition at line 1459 of file p6kmipclient.h.
