Click or drag to resize

SQLTable Class (Typed)

X#
Manage a table.
Inheritance Hierarchy
Object
  DataServer
    SQLSelect
      SQLTable

Namespace:  XSharp.VO.SDK
Assembly:  XSharp.VOSQLClasses (in XSharp.VOSQLClasses.dll) Version: 2.19
Syntax
[TypesChangedAttribute]
 CLASS SQLTable INHERIT SQLSelect
Request Example View Source

The SQLTable type exposes the following members.

Constructors
  NameDescription
Public methodSQLTable
Construct a SQLTable object.
Top
Properties
  NameDescription
Public propertyAppendData (Inherited from SQLSelect.)
Public propertyAppendFlag
**Missing documentation **
(Inherited from SQLSelect.)
Public propertyBatchUpdates (Inherited from SQLSelect.)
Public propertyBoF
A logical value indicating whether the server is positioned at the beginning of the result set, on the first row.
(Inherited from SQLSelect.)
Public propertyClients
**Missing documentation **
(Inherited from DataServer.)
Public propertyConcurrencyControl
A constant, identifying the mode of automatic concurrency control for this data server, determining when and how records are locked and released:
(Inherited from DataServer.)
Public propertyConnection
The SQL connection object that the SQLSelect is using to manipulate the result set.
(Inherited from SQLSelect.)
Public propertyCursorName
A string containing the cursor name.
(Inherited from SQLSelect.)
Public propertyDBStruct
An array containing the structure of this data server.
(Inherited from SQLSelect.)
Public propertyDeleted
A logical value indicating whether the current row has been deleted.
(Inherited from SQLSelect.)
Public propertyEoF
A logical value indicating whether the server is positioned at the end of the result set, after the last row.
(Inherited from SQLSelect.)
Public propertyErrInfo
An SQLErrorInformation object.
(Inherited from SQLSelect.)
Public propertyFCount
The number of columns in the result set. A value of -1 indicates an error.
(Inherited from SQLSelect.)
Public propertyFields
Public propertyFOUND
A logical value indicating whether the previous search operation succeeded.
(Inherited from SQLSelect.)
Public propertyHLStatus
**Missing documentation **
(Inherited from DataServer.)
Public propertyHyperLabel (Inherited from SQLSelect.)
Public propertyIndexColumns (Inherited from SQLSelect.)
Public propertyLastRec (Inherited from SQLSelect.)
Public propertylRowModified (Inherited from SQLSelect.)
Public propertyModified (Inherited from SQLSelect.)
Public propertyMoreResults
A logical value representing whether there are more rows to retrieve.
(Inherited from SQLSelect.)
Public propertyName
A string representing the name of this data server.
(Inherited from DataServer.)
Public propertyNameSym
A symbol representing the name of this data server.
(Inherited from DataServer.)
Public propertyNativeSQL
A string containing the native SQL text of the statement. Level 2
(Inherited from SQLSelect.)
Public propertyNullAsBlank
A logical value determining whether SQL NULL values are strongly typed (TRUE) or not (FALSE, default value).
(Inherited from SQLSelect.)
Public propertyNumCols (Inherited from SQLSelect.)
Public propertyNumParameters
A numeric value containing the number of parameters. A value of -1 indicates an error. Level 2
(Inherited from SQLSelect.)
Public propertyNumResultColumns
A numeric value containing the number of columns in the result set.
(Inherited from SQLSelect.)
Public propertyNumSuccessfulRows
A numeric value containing the number of rows that were modified by a delete, append, or update operation.
(Inherited from SQLSelect.)
Public propertyOrderByClause
Public propertyOrderSeek
Public propertyPrepFlag
A logical value that indicates if the select statement has been prepared.
(Inherited from SQLSelect.)
Public propertyReadOnly (Inherited from SQLSelect.)
Public propertyRecCount
A numeric value representing the number of rows in the data server.
(Inherited from SQLSelect.)
Public propertyRecNo (Inherited from SQLSelect.)
Public propertySQLColumns
**Missing documentation **
(Inherited from SQLSelect.)
Public propertySqlData
**Missing documentation **
(Inherited from SQLSelect.)
Public propertySQLString
A string representing the SQL statement text.
(Inherited from SQLSelect.)
Public propertyStatement
A SQL statement object.
(Inherited from SQLSelect.)
Public propertyStatementHandle
A numeric value representing the statement handle.
(Inherited from SQLSelect.)
Public propertyCode exampleStatus
A hyperlabel object identifying the status after the last operation.
(Inherited from SQLSelect.)
Public propertySuffix
Public propertyTable
Public propertyTableName
A string representing the name of the table.
(Inherited from SQLSelect.)
Public propertyTimeStampAsDate
**Missing documentation **
(Inherited from SQLSelect.)
Public propertyUsed
A logical value indicating whether the current query is active. It returns TRUE if the current query is active; otherwise, it returns FALSE.
(Inherited from SQLSelect.)
Public propertyWhereClause
Public propertyWhereSeek
Top
Functions
  NameDescription
Public methodAddDateVal (Inherited from SQLSelect.)
Public methodAddTimeString (Inherited from SQLSelect.)
Public methodCode exampleAppend
Create a blank row in the buffer; this blank row becomes the current position and is ready for assignment of data values. The SQLSelect:RecNo of this buffer is SQLSelect:RecCount+1.
(Inherited from SQLSelect.)
Public methodAppendRow
Insert the row that has been created in the buffer since the last SQLSelect:Append() operation.
(Inherited from SQLSelect.)
Public methodAsString
Return the descriptive label defined for this data server.
(Inherited from DataServer.)
Public methodBindColumn Obsolete. (Inherited from SQLSelect.)
Public methodClearRelation
Clear a relation (or all relations) held by this server to other servers.
Public methodClose
Close the cursor corresponding to the server. Note that the database connection is not closed, only the cursor.
(Inherited from SQLSelect.)
Public methodColumn
Return a specified SQL column.
(Inherited from SQLSelect.)
Public methodColumnAttributes
Return the SQL column attributes for a specified column.
(Inherited from SQLSelect.)
Public methodCommit
Save the changes (updates and deletes) made since the last Commit().
(Inherited from SQLSelect.)
Public methodCondition
Store any other condition that is appended to the end of the SQL statement.
Public methodDataField
Return the data (DataField object) at a specified column position.
(Inherited from SQLSelect.)
Public methodDelete
Delete the current row.
(Inherited from SQLSelect.)
Public methodDirectSkip (Inherited from SQLSelect.)
Public methodError
Provide a method for handling error conditions raised during database processing. This is an event handler: it is automatically called by other methods; the developer does not normally need to call the error method, but might want to replace or amend it.
(Inherited from SQLSelect.)
Public methodCode exampleExecute
Open the cursor.
(Inherited from SQLSelect.)
Public methodExtendedFetch
Provide extended fetch capabilities, specifying type and row.
(Inherited from SQLSelect.)
Public methodFetch
Fetch the next row.
(Inherited from SQLSelect.)
Public methodFieldGet (Inherited from SQLSelect.)
Public methodFieldGetFormatted
Retrieve the contents of the specified column according to the formatting specifications of its field specification.
(Inherited from SQLSelect.)
Public methodFieldHyperLabel
Return the hyperlabel of a specified column.
(Inherited from SQLSelect.)
Public methodFieldInfo
Retrieve information about or set an alias for the indicated column.
(Inherited from SQLSelect.)
Public methodFieldName
Return the name of a specified column. Note that the column's hyperlabel also contains a name.
(Inherited from SQLSelect.)
Public methodFieldPos
Return the position of a specified column within the data server, as a number starting with 1.
(Inherited from SQLSelect.)
Public methodFieldPut (Inherited from SQLSelect.)
Public methodFieldSpec
Return the field specification object for the indicated column.
(Inherited from SQLSelect.)
Public methodFieldStatus
Return a hyperlabel object identifying the status after the last operation.
(Inherited from SQLSelect.)
Public methodFieldSym
Return the symbolic name of a specified column. Note that the column's hyperlabel also contains a name; these two names are the same in the code generated by the SQL Editor.
(Inherited from SQLSelect.)
Public methodFieldValidate
Validate the provided value according to the validation rules of the indicated column's FieldSpec.
(Inherited from SQLSelect.)
Public methodFLock (Inherited from SQLSelect.)
Public methodFreeStmt
Free the statement, according to the specified option.
(Inherited from SQLSelect.)
Public methodGetData
Retrieve the contents of the specified column.
(Inherited from SQLSelect.)
Public methodGetdateVal (Inherited from SQLSelect.)
Public methodCode exampleGetLookupTable
Retrieve a two-column array of values from two fields in the server.
(Inherited from SQLSelect.)
Public methodGetStatementOption Obsolete.
Retrieve the current setting for a statement option.
(Inherited from SQLSelect.)
Public methodGetTimeStamp (Inherited from SQLSelect.)
Public methodGetTimeString (Inherited from SQLSelect.)
Public methodCode exampleGoBottom
Position the data server on the last row.
(Inherited from SQLSelect.)
Public methodGoTo
Position the data server on the specified row number.
(Inherited from SQLSelect.)
Public methodCode exampleGoTop
Position the data server on the first row.
(Inherited from SQLSelect.)
Public methodLockCurrentRecord (Inherited from DataServer.)
Public methodNoIVarGet
Provide a general error interception that is automatically called (in any class) whenever an access reference is made to a non-existent exported instance variable. In the SQLSelect class, it is used to implement the virtual column variable.
Important! NoIVarGet() should not be called directly; it is called by the system for handling invalid references.
(Inherited from SQLSelect.)
Public methodNoIVarPut
Provide a general error interception that is automatically called (in any class) whenever an assignment reference is made to a non-existent exported instance variable.
Important! NoIVarPut() should not be called directly; it is called by the system for handling invalid references.
(Inherited from SQLSelect.)
Public methodNotify
Provide a method that is automatically called by the action methods of the server after completion of some significant event: a column has changed, the server position has changed, some operation has been completed. Its standard implementation is to broadcast the same notification to its attached clients.
(Overrides Notify(Long, Usual).)
Public methodNumResultCols
Return the number of columns in the result set.
(Inherited from SQLSelect.)
Public methodCode exampleOrderBy
Specify an ORDER BY clause.
Public methodPostInit
Implement customized initialization code for the window.
(Inherited from DataServer.)
Public methodCode examplePreExecute
Return the SQL command that is generated by X#.
(Inherited from SQLSelect.)
Public methodPreInit
Implement customized initialization code for the server.
(Inherited from DataServer.)
Public methodPrepare
Prepare the statement.
(Inherited from SQLSelect.)
Public methodRefresh
Refresh the current row in the buffer, discarding any changes that have been made.
(Inherited from SQLSelect.)
Public methodRegisterClient
Register an object as a client of this data server, so that it receives notification messages from the server about certain actions.
(Inherited from DataServer.)
Public methodRejectChanges (Inherited from SQLSelect.)
Public methodRelation
Return the linking expression of a specified relation.
Public methodRequery (Inherited from SQLSelect.)
Public methodReReadRow (Inherited from SQLSelect.)
Public methodResetCursor (Inherited from SQLSelect.)
Public methodResetNotification
Resume the broadcasting of Notify messages to the server's attached clients (after SQLSelect:SuspendNotification() has been called).
(Inherited from SQLSelect.)
Public methodRLock (Inherited from SQLSelect.)
Public methodRLockVerify
This method is provided to override the inherited functionality from the DataServer class, as it does not apply to SQLSelect.
(Inherited from SQLSelect.)
Public methodRollback
Undo the changes (updates and deletes) made since the last Commit().
(Inherited from SQLSelect.)
Public methodSeek
Move to the next record having a specified key value in the controlling order.
(Inherited from DataServer.)
Public methodSeek(Usual, Usual, Usual)
Search for a value based on a controlling search order.
Public methodSetColumnAttributes (Inherited from SQLSelect.)
Public methodSetDataField (Inherited from SQLSelect.)
Public methodSetPos Obsolete. (Inherited from SQLSelect.)
Public methodSetPrimaryKey
Specify a column to be used as a unique index in searched updates or deletes that require a key (i.e., SQLSelect:ScrollUpdateType = SQL_SC_UPD_KEY).
(Inherited from SQLSelect.)
Public methodCode exampleSetRelation
Set a relation from this server to the child server; standard database operations are restricted to those records that match the relation.
Public methodCode exampleSetSelectiveRelation
Set a selective relation from this server to the child server; standard database operations are restricted to those records that match the relation.
Public methodSetStatementOption Obsolete.
Change a statement option.
(Inherited from SQLSelect.)
Public methodSetTimeStamp (Inherited from SQLSelect.)
Public methodShowSQLError (Inherited from SQLSelect.)
Public methodSkip
Move forward or backward relative to the current row. (Similar to the Skip() function).
(Inherited from SQLSelect.)
Public methodSuspendNotification
Suspend the broadcasting of Notify messages to the server's attached clients.
(Inherited from SQLSelect.)
Public methodUnLock (Inherited from SQLSelect.)
Public methodUnRegisterClient
Remove the registration of an object as a client of this data server, so that it no longer receives notification messages from the server about certain actions.
(Inherited from DataServer.)
Public methodUpdate
Update this server with data from another server or table.
(Inherited from DataServer.)
Public methodUpdate(Usual)
Update the current row or restore the original values of the row.
(Inherited from SQLSelect.)
Public methodUpdateCursor Obsolete. (Inherited from SQLSelect.)
Public methodUpdateKey Obsolete. (Inherited from SQLSelect.)
Public methodUpdateVal Obsolete. (Inherited from SQLSelect.)
Public methodWhere
Specify a WHERE condition. The where clause is built by concatenating these conditions with the AND operator.
Top
See Also