Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
virtual P6R::P6ERR P6R::p6IKMIPClient::obtainLease ( P6NCSTR  uniqueId,
P6KMIP_MSGEXTENSION pExtension,
P6KMIP_LEASE pLease,
P6KMIP_RESULT pResult 
)
pure virtual

Request a lease on a managed object.

A lease is an interval of time where the client's view of the object is valid and after which that view (or meta-data) must be renewed. If a lease has expired, then the client is not allowed to use the cryptographic managed object until that lease is successfully renewed.

Parameters
uniqueId[ in ] optional uniqueId.pString can be NULL, add the attribute names of the managed object pointed to by this unique Id. If NULL the sserver determines the object to query.
pExtension[ in ] optional can be NULL, vendor defined extension to the operation
pLease[ out ] P6KMIP_LEASE containing specifics about the object's new assigned lease
pResult[ out ] Server returned status indicators
Returns
FailureP6R::eNotInitializedA successful call to initialize() is required.
P6R::eNotConnA successful call to open() is required before this function is called.
P6R::eInvalidArgOne of the pointers is NULL.
P6R::eFormatErrorParsing error occurred while parsing a KMIP server response.
P6R::eTooBigMessage returned by server is too big to fit in configured buffers.
P6R::eTooSmallThe configured buffer size in P6KMIP_PREF.maxBufferSize is too small to hold the request message.