Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
virtual P6R::P6ERR P6R::p6IKMIPRequest::addLocateRequest ( P6UINT32 pMaxItems,
P6UINT32 pStorageStatusMask,
P6UINT32 pObjectGroupMember,
P6UINT32  attribCount,
P6KMIP_ATTRIBUTE pAttributeList,
P6KMIP_MSGEXTENSION pExtension 
)
pure virtual

Add the locate batch item to the current request message.

A successful startRequestMsg function must be called first.

Locate (Section 4.9 KMIP spec), allows the KMIP client to request server to find managed objects that match all of the specified attributes (i.e., pAttributeList ).

Parameters
pMaxItems[ in ] optional can be NULL, define the number of matched objects returned by the server
pStorageStatusMask[ in ] optional can be NULL, see Section 9.1.3.3.2 in p6kmip.h, defines the groups of objects to be searched
pObjectGroupMember[ in ] optional can be NULL, see Section 9.1.3.2.33 in p6kmip.h, defines the groups object group member type (added to KMIP 1.1)
attribCount[ in ] specifies the number of P6KMIP_ATTRIBUTE structures pointed to by pAttributeList
pAttribList[ in ] optional can be NULL, all of the attributes must match an object for that object to be returned
pExtension[ in ] optional can be NULL, vendor defined extension to the operation
Returns
SuccessP6R::eOk 
FailureP6R::eNotInitializedA successful call to intialize() must be made before calling this funciton.
P6R::eTooSmallThe configured buffer size in pPool is too small to hold the generated message.
P6R::eInvalidStateA successful call to startRequestMsg() must be made before calling this function.
P6R::eRangepExtension->encodedExtension.length must be a multiple of 8, since encoded as the Vendor Extension Structure