DynamicDescriptionArea object

DynamicDescriptionArea is a PowerBuilder system object that stores information about the input and output parameters used in Format 4 of dynamic SQL.

PowerBuilder provides a global DynamicDescriptionArea named SQLDA that you can use when you need a DynamicDescriptionArea variable. If necessary, you can declare and create additional variables of this type using this system object as the datatype.

For more information about using dynamic SQL, see the PowerScript Reference.

Properties

DynamicDescription Area property

Datatype

Description

ClassDefinition

PowerObject

An object of type PowerObject containing information about the class definition of the object or control.

NumInputs

Integer

Specifies the number of input parameters found in the dynamic SQL PREPARE statement.

PowerBuilder populates this property when the DESCRIBE statement is executed.

NumOutputs

Integer

Specifies the number of output parameters found in the PREPARE statement.

If the database supports output parameter description, PowerBuilder populates this property when the DESCRIBE statement is executed. If the database does not support output parameter description, PowerBuilder populates this property when the FETCH statement is executed.

InParmType[ ]

ParmType (enumerated)

Array containing values specifying the datatype of each input parameter. Values are:

  • TypeBoolean!

  • TypeByte!

  • TypeDate!

  • TypeDateTime!

  • TypeDecimal!

  • TypeDouble!

  • TypeInteger!

  • TypeLong!

  • TypeLongLong!

  • TypeReal!

  • TypeString!

  • TypeTime!

  • TypeUInt!

  • TypeULong!

  • TypeUnknown!

OutParmType[ ]

ParmType (enumerated)

Array containing values specifying the datatype of each output parameter returned.

Events

DynamicDescription Area event

Occurs

Constructor

Immediately before the Open event occurs

Destructor

Immediately after the Close event occurs

Functions

DynamicDescription Area function

Datatype returned

Description

ClassName

String

Returns the name assigned to the object.

GetContextService

Integer

Creates a reference to a context-specific instance of the specified service.

GetDynamicDate

Date

Obtains data of type Date from the DynamicDescriptionArea after you have executed a dynamic SQL statement.

Use GetDynamicDate when the value of OutParmType is TypeDate! for the value in the array that you want to retrieve.

GetDynamicDateTime

DateTime

Obtains data of type DateTime from the DynamicDescriptionArea after you have executed a dynamic SQL statement.

Use GetDynamicDateTime when the value of OutParmType is TypeDateTime! for the value in the array that you want to retrieve.

GetDynamicDecimal

LongLong

Obtains numeric data from the DynamicDescriptionArea after you have executed a dynamic SQL statement.

Use GetDynamicDecimal when the value of OutParmType is TypeDecimal! or TypeLongLong! for the value in the array that you want to retrieve.

GetDynamicNumber

Double

Obtains numeric data from the DynamicDescriptionArea after you have executed a dynamic SQL statement.

Use GetDynamicNumber when the value of OutParmType is TypeByte!, TypeInteger!, TypeDouble!, TypeLong!, TypeReal!, or TypeBoolean! for the value in the array that you want to retrieve.

GetDynamicString

String

Obtains data of type String from the DynamicDescriptionArea after you have executed a dynamic SQL statement.

Use GetDynamicString when the value of OutParmType is TypeString! for the value in the array that you want to retrieve.

GetDynamicTime

Time

Obtains data of type Time from the DynamicDescriptionArea after you have executed a dynamic SQL statement.

Use GetDynamicTime when the value of OutParmType is TypeTime! for the value in the array that you want to retrieve.

GetParent

PowerObject

Returns a reference to the name of the parent object.

PostEvent

Boolean

Adds the specified event to the end of the message queue for the object.

SetDynamicParm

Integer

Specifies a value for an input parameter in the DynamicDescriptionArea that will be used in the SQL OPEN or EXECUTE statement.

Use SetDynamicParm to fill the parameters in the input parameter descriptor array in the DynamicDescriptionArea.

TriggerEvent

Integer

Triggers a specified event in the object and executes the script for the event.

TypeOf

Object

Returns the type of the object.