Function codes

Function codes passed to the FOBJ provider as the third parameter. More...

Macros
#define	FOBJ_FUNC_OPN   1U
	Open storage / connect to the namespace. Requires prior FOBJ_FUNC_NEW (*ppHdl must not be NULL). State transition: NEW -> OPEN.
#define	FOBJ_FUNC_CLS   2U
	Close / disconnect from storage. The provider handle is not freed; the handle returns to NEW state. State transition: OPEN -> NEW.
#define	FOBJ_FUNC_GET   3U
	Retrieve an object by string key (locate call – no copy). OPEN state only.
#define	FOBJ_FUNC_PUT   4U
	Store an object by string key. OPEN state only.
#define	FOBJ_FUNC_DEL   5U
	Delete an object by string key. OPEN state only.
#define	FOBJ_FUNC_CHK   6U
	Check whether an object exists and meets a minimum size. OPEN state only.
#define	FOBJ_FUNC_DST   7U
	Delete the entire store namespace. NEW state only. The provider manages any temporary connection internally.
#define	FOBJ_FUNC_EXS   8U
	Check whether an object (identified by string key) exists in the store. NEW state only; the provider manages any temporary connection internally. Output: TsFobjExs.isExists (1 = exists, 0 = absent).
#define	FOBJ_FUNC_NEW   9U
	Allocate a provider handle and store the archive name and parameter string. No storage I/O is performed. State transition: EMPTY -> NEW. *ppHdl must be NULL on entry.
#define	FOBJ_FUNC_FRE   10U
	Free the provider handle. No storage I/O is performed. Must be called in NEW state (storage already closed). State transition: NEW -> EMPTY. The provider must set *ppHdl to NULL.

Detailed Description

Function codes passed to the FOBJ provider as the third parameter.

The function code determines which member of TuFobjPar is active. Only the union member that corresponds to the current function code may be read or written; accessing any other member is undefined behavior.

Macro Definition Documentation

FOBJ_FUNC_CHK

#define FOBJ_FUNC_CHK   6U

Check whether an object exists and meets a minimum size. OPEN state only.

FOBJ_FUNC_CLS

#define FOBJ_FUNC_CLS   2U

Close / disconnect from storage. The provider handle is not freed; the handle returns to NEW state. State transition: OPEN -> NEW.

FOBJ_FUNC_DEL

#define FOBJ_FUNC_DEL   5U

Delete an object by string key. OPEN state only.

FOBJ_FUNC_DST

#define FOBJ_FUNC_DST   7U

Delete the entire store namespace. NEW state only. The provider manages any temporary connection internally.

FOBJ_FUNC_EXS

#define FOBJ_FUNC_EXS   8U

Check whether an object (identified by string key) exists in the store. NEW state only; the provider manages any temporary connection internally. Output: TsFobjExs.isExists (1 = exists, 0 = absent).

FOBJ_FUNC_FRE

#define FOBJ_FUNC_FRE   10U

Free the provider handle. No storage I/O is performed. Must be called in NEW state (storage already closed). State transition: NEW -> EMPTY. The provider must set *ppHdl to NULL.

FOBJ_FUNC_GET

#define FOBJ_FUNC_GET   3U

Retrieve an object by string key (locate call – no copy). OPEN state only.

FOBJ_FUNC_NEW

#define FOBJ_FUNC_NEW   9U

Allocate a provider handle and store the archive name and parameter string. No storage I/O is performed. State transition: EMPTY -> NEW. *ppHdl must be NULL on entry.

FOBJ_FUNC_OPN

#define FOBJ_FUNC_OPN   1U

Open storage / connect to the namespace. Requires prior FOBJ_FUNC_NEW (*ppHdl must not be NULL). State transition: NEW -> OPEN.

FOBJ_FUNC_PUT

#define FOBJ_FUNC_PUT   4U

Store an object by string key. OPEN state only.