Product Documentation

c-treeDB API API for C

Previous Topic

Next Topic

ctdbFindTableByUID

Get the name and path of a table in a database dictionary by its unique identifier.

Declaration

CTDBRET ctdbFindTableByUID(CTHANDLE Handle, ULONG uid, pTEXT Name,

VRLEN NameSize, pTEXT Path, VRLEN PathSize)

Description

ctdbFindTableByUID() retrieves the name and path of a table in a database dictionary by its unique identifier. Use ctdbFindTable() to get the path of a table in the database dictionary by name. Use ctdbGetTableUID() to retrieve the table UID.

  • Handle [in] the handle of the database to be searched.
  • uid [in] the unique table identifier, used to find the table.
  • Name [out] the string with the table name.
  • NameSize [in] the name size in bytes. If Name is not large enough to receive the table name, ctdbFindTableByUID() will return CTDBRET_ARGSMALL (4006).
  • Path [out] the path of the table, if the table is located, and it is large enough to hold the path. The path includes drive, directory, name and extension.
  • PathSize [in] the path size in bytes. If Path is not large enough to receive the table path, ctdbFindTableByUID() will return CTDBRET_ARGSMALL (4006).

Returns

ctdbFindTableByUID() returns CTDBRET_OK on success, or INOT_ERR (101) if the table cannot be found in the database dictionary, or a c-tree error code on failure.

See also

ctdbFindTable(), ctdbFirstTable(), ctdbNextTable(), ctdbGetTableUID()

TOCIndex