Add the locate batch item to the current request message.
A successful startRequestMsg function must be called first. This method supports the offset items option where the caller can specify a starting offset into the search results thus allowing the caller to page through the result set max items at a time.
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 |
| pOffsetItems | [ in ] optional can be NULL, define the number of unique identifers to skip that match the search criteria (can be used for paging, added to KMIP 1.3) |
| 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
| Success | P6R::eOk | |
| Failure | P6R::eNotInitialized | A successful call to intialize() must be made before calling this funciton. |
| P6R::eTooSmall | The configured buffer size in pPool is too small to hold the generated message. |
| P6R::eInvalidState | A successful call to startRequestMsg() must be made before calling this function. |
| P6R::eInvalidVersion | pOffsetItems was add to KMIP 1.3 and cannot be used in earlier versions. |
| P6R::eRange | pExtension->encodedExtension.length must be a multiple of 8, since encoded as the Vendor Extension Structure |
