Product Documentation

c-treeDB API API for C

Previous Topic

Next Topic

ctdbGetAttachMode

Declaration

CTATTACH_MODE ctdbDECL ctdbGetAttachMode(CTHANDLE Handle);

Description

Retrieve the current session attach mode. ctdbGetAttachMode() will not execute a c-tree instance switch.

  • Handle is a session handle.

Return Values

One of the following values is returned:

Returned CTATTACH mode

Description

CTATTACH_NONE

Handle or Session object is not attached, or Handle not a valid session handle.

CTATTACH_SESSION

Handle or Session object is attached to a c-treeDB API session.

CTATTACH_CTREEID

Handle or Session object is attached to a c-tree instance id.

CTATTACH_CURRENT

Handle or Session object was attached to current c-tree instance.

See Also

ctdbAttachSession(), ctdbDetachSession()

TOCIndex