FairCom DB API for C

ctdbSetLocalTag

Sets the localTag pointer.

DECLARATION

CTDBRET ctdbSetLocalTag(CTHANDLE Handle, pVOID pTag);

DESCRIPTION

The local tag pointer, pTag, is a place holder for data storage specific to each callback type implementation. A callback function implementation may use this tag to store local data.

The localTag pointer is available for FairCom DB API session, database, table and record handles, and it is initialized with NULL when the handle is allocated.

RETURN

Value	Symbolic Constant	Explanation
0	CTDBRET_OK	No error occurred.

See Appendix A for a complete listing of valid c-tree Plus error values.

EXAMPLE

if (ctdbSetLocalTag(Handle, pSession->onAlloc(1000)))

printf("ctdbSetLocalTag failed\n");