Parameters for FOBJ_FUNC_NEW. More...

#include <FOBJ.h>

Data Fields
unsigned int	uiNamLen
	[INPUT] Byte length of pcNamStr (without null).
unsigned int	uiParLen
	[INPUT] Byte length of pcParStr (without null). Paired with uiNamLen so that both pointers start on 8-byte boundaries.
const char *	pcNamStr
	[INPUT] Archive namespace string (null-terminated). The provider must copy this string; the pointer is only valid for the duration of this call.
const char *	pcParStr
	[INPUT] Provider-specific parameter string (null-terminated). Same lifetime constraint as pcNamStr.
unsigned int	uiMaxObjLen
	[INPUT] Largest object this store has to expect in normal operation, in bytes, or 0 when the caller has no expectation. Same meaning as `TsFobjOpn::uiMaxObjLen` and carrying the same value – repeated here because a provider that pre-allocates its buffers does so in FOBJ_FUNC_NEW, before any OPN. A hint, never a bound. Added in interface version 0x0201.

Detailed Description

Parameters for FOBJ_FUNC_NEW.

The bridge passes the archive namespace and provider parameter string so the provider can copy them into its handle for use in subsequent FOBJ_FUNC_OPN, FOBJ_FUNC_DST, and FOBJ_FUNC_EXS calls. No storage I/O takes place.

On entry *ppHdl is NULL. The provider must allocate its handle and write the pointer to *ppHdl.

Field Documentation

◆ pcNamStr

const char* FobjNew::pcNamStr

[INPUT] Archive namespace string (null-terminated). The provider must copy this string; the pointer is only valid for the duration of this call.

◆ pcParStr

const char* FobjNew::pcParStr

[INPUT] Provider-specific parameter string (null-terminated). Same lifetime constraint as pcNamStr.

◆ uiMaxObjLen

unsigned int FobjNew::uiMaxObjLen

[INPUT] Largest object this store has to expect in normal operation, in bytes, or 0 when the caller has no expectation. Same meaning as TsFobjOpn::uiMaxObjLen and carrying the same value – repeated here because a provider that pre-allocates its buffers does so in FOBJ_FUNC_NEW, before any OPN. A hint, never a bound. Added in interface version 0x0201.

◆ uiNamLen

unsigned int FobjNew::uiNamLen

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

◆ uiParLen

unsigned int FobjNew::uiParLen

[INPUT] Byte length of pcParStr (without null). Paired with uiNamLen so that both pointers start on 8-byte boundaries.

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

FOBJ.h