Product Documentation

c-treeDB API API for C

Previous Topic

Next Topic

ctdbGetLocalTag

Retrieves the local tag associate with a handle.

DECLARATION

pVOID ctdbGetLocalTag(CTHANDLE Handle);

DESCRIPTION

Retrieves the local tag associated with a handle. A localTag pointer is available for session, database, table and record handles, and is initialized with NULL when the handle is allocated.

  • Handle is any c-treeDB API session, table, record, or index handle.

RETURN

A pointer to a localTag, or NULL if Handle is NULL.

EXAMPLE

if (ctdbGetLocalTag(Handle))

{

pSession->onFree(ctdbGetLocalTag(Handle));

ctdbSetLocalTag(Handle, NULL);

}

SEE ALSO

ctdbGetHandleType(), ctdbSetLocalTag()

TOCIndex