DBrollback

Synopsis

DBrollback aborts the changes in the current transaction.

Input Ports

dbvisual_connect_descriptor ptr to a structure

process_rollback int

Parameters

message string

connect_information DBconnectInformation group

db_specific_error_message string

db_specific_error_code int

processing int

return_code int

Output Ports

None

Description

DBrollback aborts the changes in the current transaction by executing an SQL ROLLBACK statement. ( The current transaction include s all command s executed on the current connection.) After rolling back the changes, DBrollback terminates the transaction.

Input

dbvisual_connect_descriptor

A pointer to the connection descriptor of the session in which DBquery is to execute. This is the output of the DBconnect module that initiated the session.

CAUTION: Do not modify this value. A fatal error will result.

process_rollback

A trigger that initiates execution of the ROLLBACK statement. When this value changes to a value greater than 0, the rollback is executed.

Parameters

message

An message that describes the status of the rollback.

connect_information

Information about the current connection:

the database driver

the server host

the server name

the database name

the user ID

the connect string

the status of the connection: connected (1) or disconnected (0)

This parameter is of type DBconnectInformation.

db_specific_error_message

An error message returned by the database server when an error occurs during its processing of the rollback. For more information, see your database documentation.

db_specific_error_code

An error code associated with the error message returned by the database server when an error occurs during its processing of the rollback. A value of 0 indicates success; a nonzero value indicates failure. For more information, see your database documentation.

processing

A return value that indicates the processing status of the rollback. This value is set to 1 while the rollback is being processed and is cleared to 0 to indicate that the rollback has completed.

return_code

The status code associated with the message returned in the message parameter. A value of 0 indicates success; a nonzero value indicates failure.

Output Port

none.

Example

Not available.

File

v/db.v

See also related modules

DBcommit