Transaction object

The Transaction object specifies the parameters that PowerBuilder uses to connect to a database.

You can customize your own version of the Transaction object by defining a class user object inherited from the built-in Transaction object.

For more information about creating a custom Transaction object, see the section called “Working with User Objects” in Users Guide.

For more information about using the Transaction object in an application, see the section called “Using Transaction Objects” in Application Techniques.

Properties

Transaction property

Datatype

Description

AutoCommit

Boolean

The automatic commit indicator. Values are:

TRUE -- Commit automatically after every database activity.

FALSE -- Do not commit automatically after every database activity.

ClassDefinition

PowerObject

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

Database

String

The name of the database with which you are connecting.

DBMS

String

PowerBuilder vendor identifier.

DBParm

String

DBMS-specific parameters.

DBPass

String

The password used to connect to the database.

Lock

String

The isolation level.

LogID

String

The name or ID of the user who logs in to the server.

LogPass

String

The password used to log in to the server.

ServerName

String

The name of the server on which the database resides.

SQLCode

Long

The success or failure code of the most recent operation.

Return codes:

0 -- Success

100 -- Not found

-1 -- Error (use SQLDBCode or SQLErrText to obtain the details)

SQLDBCode

Long

The database vendor's error code.

SQLErrText

String

The database vendor's error message.

SQLNRows

Long

The number of rows affected (the database vendor supplies this number, so the meaning might not be the same in every DBMS)

SQLReturnData

String

DBMS-specific information

UserID

String

The name or ID of the user who will connect to the database


Events

Transaction event

Occurs

Constructor

When the user object is created

DBNotification

When an Oracle 10g server sends a notification that a database operation has occurred

DBError

When a database error occurs in the transaction

Destructor

When the user object is destroyed

SQLPreview

Occurs immediately before a SQL statement is submitted to the DBMS


Functions

Transaction function

Datatype returned

Description

ClassName

String

Returns the name assigned to the user object

DBHandle

Long

Returns the handle for your DBMS

EnableSecureConnection

Integer

Enables the database secure connection

GetContextService

Integer

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

GetParent

PowerObject

Returns a reference to the name of the parent object

PostEvent

Boolean

Adds an event to the end of the message queue of the user object

SetSecureConnectionProperty

Integer

Changes the value of the transaction object property in the encrypted connection string

SetSecureConnectionString

Integer

Specifies the encrypted string to be used during the database connection

SyntaxFromSQL

String

Generates DataWindow source code based on a SQL SELECT statement

TriggerEvent

Integer

Sends an event to the user object and executes the script associated with the event

TypeOf

Object

Returns the type of the user object