Describe functions

OCIDescribeAny

Purpose : You can call this function to describe existing schema and subschema objects.

Syntax :

sword OCIDescribeAny ( OCISvcCtx       *svchp,
OCIError        *errhp,
void            *objptr,
ub4              objptr_len,
ub1              objptr_typ,
ub1              info_level,
ub1              objtyp,
OCIDescribe     *dschp );

Parameters :

Return value : None.

objptr (IN)

This parameter can be a string that contains the name of the object to be described. It must be in the encoding specified by the charset parameter in the previous call to the OCIEnvNlsCreate() function.

In this case, the string that contains the object name must be in the name1[.name2 ...][@linkname] format. Example: hr.employees.employee_id@mydb. Database links are allowed only to Oracle8i or later databases. The following SQL rules are used to interpret the object name:

• If you only specify name1, and objtyp equals OCI_PTYPE_SCHEMA, the name refers to the named schema. The Oracle database must be version 8.1 or later.

• If you only specify name1, and objtyp equals OCI_PTYPE_DATABASE, the name refers to the named database. When you use database_name@db_link_name to describe a remote Oracle database, the remote database must be version 8.1 or later.

• If you only specify name1, and objtyp is not equal to OCI_PTYPE_SCHEMA or OCI_PTYPE_DATABASE, the name refers to the named object in the current schema of the current user. The named object can be a table, view, procedure, function, package, type, synonym, or sequence. When an Oracle7 Server is connected, the named object can only be a procedure or function.

• If you specify name1.name2.name3 ..., the object name refers to a schema or a subschema object in the schema named name1. For example, in the string hr.employees.department_id, hr is the name of the schema, employees is the name of a table in the schema, and department_id is the name of a column in the table.

Valid values of objtyp (IN)