Parameters for FOBJ_FUNC_GET. More...

#include <FOBJ.h>

Data Fields
unsigned int	uiKeyLen
	[INPUT] Byte length of pcKeyStr (without null).
unsigned int	uiDatLen
	[OUTPUT] Number of valid bytes at `*ppDatPtr`.
const char *	pcKeyStr
	[INPUT] Object key string (null-terminated).
const unsigned char *	ppDatPtr
	[OUTPUT] Pointer to provider's internal data buffer.

Detailed Description

Parameters for FOBJ_FUNC_GET.

Locate semantics: the provider writes a pointer to its internal buffer into *ppDatPtr and the number of valid bytes into uiDatLen. The pointer must remain valid until the next call to FOBJ_FUNC_GET or FOBJ_FUNC_CLS on the same handle. The provider owns and frees the buffer; the caller must not free it.

Providers backed by a remote store must allocate an internal buffer and write its address into *ppDatPtr. For memory-mapped or in-process backends this is truly zero-copy.

Field Documentation

◆ pcKeyStr

const char* FobjGet::pcKeyStr

[INPUT] Object key string (null-terminated).

◆ ppDatPtr

const unsigned char* FobjGet::ppDatPtr

[OUTPUT] Pointer to provider's internal data buffer.

◆ uiDatLen

unsigned int FobjGet::uiDatLen

[OUTPUT] Number of valid bytes at *ppDatPtr.

◆ uiKeyLen

unsigned int FobjGet::uiKeyLen

[INPUT] Byte length of pcKeyStr (without null).

The documentation for this struct was generated from the following file:

FOBJ.h