C# Class ACR_ServerMisc.ScriptDatabaseConnection

This class encapsulates a script-managed database connection.
Show file Open project: ALandFarAway/ALFA-Base-Resources Class Usage Examples

Public Methods

Method Description
CreateScriptDatabaseConnection ( string ConnectionString, ScriptDatabaseConnectionFlags Flags ) : int

Create a new database connection object and return a handle to it.

DestroyDatabaseConnection ( int ConnectionHandle ) : bool

Remove a database connection object by handle.

EscapeStringDatabaseConnection ( int ConnectionHandle, string Str, ACR_ServerMisc Script ) : string

GetEscape a string for subsequent safe use in a database query.

FetchDatabaseConnection ( int ConnectionHandle, ACR_ServerMisc Script ) : bool

Fetch a database rowset.

GetAffectedRowCountDatabaseConnection ( int ConnectionHandle, ACR_ServerMisc Script ) : int

Get the affected row count from a database rowset.

GetColumnDatabaseConnection ( int ConnectionHandle, int ColumnIndex, ACR_ServerMisc Script ) : string

Get a column from a fetched a database rowset.

QueryDatabaseConnection ( int ConnectionHandle, string Query, ACR_ServerMisc Script ) : bool

Execute a database query.

Private Methods

Method Description
GetStandardDatabaseConnectionString ( ) : string

Generate the query string used for the standard database connection.

LogQuery ( string LogText ) : void

Log text to the standard query log.

ScriptDatabaseConnection ( string ConnectionString, ScriptDatabaseConnectionFlags Flags ) : System

Create a new database connection object.

Method Details

CreateScriptDatabaseConnection() public static method

Create a new database connection object and return a handle to it.
public static CreateScriptDatabaseConnection ( string ConnectionString, ScriptDatabaseConnectionFlags Flags ) : int
ConnectionString string Supplies the connection string. ///
Flags ScriptDatabaseConnectionFlags Supplies control flags.
return int

DestroyDatabaseConnection() public static method

Remove a database connection object by handle.
public static DestroyDatabaseConnection ( int ConnectionHandle ) : bool
ConnectionHandle int Supplies a handle to the database /// connection to delete.
return bool

EscapeStringDatabaseConnection() public static method

GetEscape a string for subsequent safe use in a database query.
public static EscapeStringDatabaseConnection ( int ConnectionHandle, string Str, ACR_ServerMisc Script ) : string
ConnectionHandle int Supplies a database connection /// handle.
Str string Supplies the string to escape.
Script ACR_ServerMisc Supplies the script object.
return string

FetchDatabaseConnection() public static method

Fetch a database rowset.
public static FetchDatabaseConnection ( int ConnectionHandle, ACR_ServerMisc Script ) : bool
ConnectionHandle int Supplies a database connection /// handle.
Script ACR_ServerMisc Supplies the script object.
return bool

GetAffectedRowCountDatabaseConnection() public static method

Get the affected row count from a database rowset.
public static GetAffectedRowCountDatabaseConnection ( int ConnectionHandle, ACR_ServerMisc Script ) : int
ConnectionHandle int Supplies a database connection /// handle.
Script ACR_ServerMisc Supplies the script object.
return int

GetColumnDatabaseConnection() public static method

Get a column from a fetched a database rowset.
public static GetColumnDatabaseConnection ( int ConnectionHandle, int ColumnIndex, ACR_ServerMisc Script ) : string
ConnectionHandle int Supplies a database connection /// handle.
ColumnIndex int Supplies the column index.
Script ACR_ServerMisc Supplies the script object.
return string

QueryDatabaseConnection() public static method

Execute a database query.
public static QueryDatabaseConnection ( int ConnectionHandle, string Query, ACR_ServerMisc Script ) : bool
ConnectionHandle int Supplies a database connection /// handle.
Query string Supplies the query.
Script ACR_ServerMisc Supplies the script object.
return bool