Reference Manual
   CHAPTER 9. SQL Statements     

GET DESCRIPTOR statement [ESQL]

Function 

Retrieves information about a variable within a descriptor area, or retrieves its value.

Syntax 

GET DESCRIPTOR descriptor-name
...{ hostvar = COUNT | VALUE n assignment [,...] }

Parameters 

assignment:
hostvar = { TYPE | LENGTH | PRECISION | SCALE | DATA | INDICATOR | NAME | NULLABLE | RETURNED_LENGTH }

Permissions 

None.

Side effects 

None.

See also 

ALLOCATE DESCRIPTOR statement

DEALLOCATE DESCRIPTOR statement

SET DESCRIPTOR statement

The SQL descriptor area (SQLDA)

Description 

The GET DESCRIPTOR statement is used to retrieve information about a variable within a descriptor area, or to retrieve its value.

The value n specifies the variable in the descriptor area about which the information will be retrieved. Type checking is performed when doing GET ... DATA to ensure that the host variable and the descriptor variable have the same data type.

If an error occurs, it is returned in the SQLCA.

Standards and compatibility 

• SQL/92     Entry level feature.

• Sybase     Supported by Open Client/Open Server.

Example 

• For an example, see ALLOCATE DESCRIPTOR statement.