3. System Classes : ButtonField Class : DataStream Class
 
Share this page                  
DataStream Class
DataStream Attributes
Attribute
Data Type
Description
Inherited
From
Breaks
array of BreakSpec
Stores the DataStream's data breaks in sorted order by break level (R)
Defined
ClassName
varchar(32)
Gives the name of an object's actual type (as opposed to its declared type) (R)
Object
ClientData
Object
Provides a way to associate data with an object (RW)
Object
ClientInteger
integer
An arbitrary integer for use by the user (RW)
Defined
Columns
array of QueryCol
Contains information from the database such as each column's data type, its value (if selected), and its name (RW)
Defined
CurBreakLevel
smallint
Contains the value of the current break level (R)
Defined
CurRow
integer
Provides the row number of the current retrieved row of the query (R)
Defined
ErrorNo
integer
Provides the error number of the last operation (R)
Defined
InstanceIdentifier
integer
Contains a value that uniquely identifies an instance of an allocated object (R)
Object
InstanceReferences
integer
Contains the current number of references to the object
Object
IsDBError
integer
Is TRUE if an error in the ErrorNo attribute is a database error (R)
Defined
MaxRow
integer
Provides the row number of the last row returned by the query (R)
Defined
Name
varchar(32)
Stores the optional name you assign to identify a query (RW)
Defined
NextBreakLevel
smallint
Contains the value of the next break level (R)
Defined
QueryMode
smallint
Specifies the current mode of the query (R)
Defined
Scope
Scope
Represents the scope used to compile and evaluate dynamic expressions in the targets and parameter substitutions of the DataStream object (RW)
Defined
State
smallint
Represents the state of the query (R)
Defined
SuppressErrorTrace
smallint
If TRUE, OpenROAD does not print non-database error messages to the Trace window from the data stream's methods (RW)
Defined
TargetArray
ArrayObject
Holds the array associated with a frame's table field (RW)
Defined
TargetPrefix
varchar(256)
Specifies a prefix to be attached to all compiled expressions used in target mappings in which the QueryParm's UsePrefix attribute is set to TRUE (RW)
Defined
 
DataStream Methods
Method
Return
Value
Description
Inherited From
AddBreak(columnindex = integer, level = integer
[, formatstring = varchar(256)])
none
Adds a new break condition to the DataStream
Defined
ClearBreaks()
none
Removes all break conditions from the DataStream
Defined
Close()
none
Closes the query
Defined
Duplicate()
DataStream
Makes a duplicate of the object, placing a reference to the new object in a reference variable
Object
FetchRow(rowindex = integer)
integer
Sets the current row in the cache to the row specified in the rowindex parameter
Defined
GetAttribute
(
attributename = byref(variable)
{,attributename = byref(variable)})
integer
Gets the values of any number of attributes for the object
Object
IsA
(class =
classname)
integer
Returns TRUE if the object is of the same class as, or one of the subclasses of, the class specified by classname
Object
Load()
integer
Moves data into target variables, objects, or fields on the frame
Defined
NextRow()
integer
Retrieves the next row of data from the database into internal buffers
Defined
Open
(querymode =
integer,
[scope = scope ]
[, checkcols = integer,
isrepeated =
integer]
[, maxrows = integer])
integer
Opens the query with the semantics implied by the specified mode
Defined
PrevRow()
status
Backs up to the previous row in the cached sequence, positioning that row to be loaded into fields or variables
Defined
SetAttribute
(
attributename = value
{,attributename = value})
integer
Sets any number of attributes for the object
Object
SetCols([scope = CompositeScope])
integer
Checks the query for syntax errors and initializes the array associated with the Columns attribute, providing name and data type information
Defined