Rate This Document

Findability

Accuracy

Completeness

Readability

BioGet

Function Definition

Reads an object.

Implementation

CResult BioGet(uint64_t tenantId, const char *key, uint64_t offset, uint64_t length, ObjLocation location, char *value, uint64_t *realLength)

Parameters

**Table 1** Parameters
Parameter	Data Type	Input/Output	Description
tenantId	uint64_t	Input	Tenant ID.
key	const char*	Input	Object key.
offset	uint64_t	Input	Offset of data to be read.
length	uint64_t	Input	Length of data to be read.
location	ObjLocation	Input	Object location.
value	char*	Input	Data buffer.
realLength	uint64_t*	Output	Real length of data to be read.

Return Values

**Table 2** Return values
Return Value	Description
RET_CACHE_OK	The operation is successful.
RET_CACHE_NOT_FOUND	The cache instance is not found.
RET_CACHE_EPERM	The input parameter is incorrect.
RET_CACHE_NOT_READY	The BoostIO service is not ready.
RET_CACHE_NEED_RETRY	A retry is required.
RET_CACHE_PT_FAULT	The object location cannot be written due to a partition error.
RET_CACHE_READ_EXCEED	The length of data to be read exceeds the length of written data.
RET_CACHE_ERROR	The operation failed.

Parent topic: API Reference