ObjectStore Active Toolkit Reference

Chapter 5

ATK Object Model

Introduction
This chapter describes the ActiveX object model exposed by ATK, whose members provide a programmatic interface to ActiveX objects in an ObjectStore database.

Overview
The ATK ActiveX object model is divided into five categories:

ATKKernel and ATKDatabase are the entry points into the ATK object model. These provide global utility functions and access to the database.

ATKReference, ATKReferences, ATKObjectManager, and ATKRoot let you navigate objects in your database, retrieve information about the kind of object you are accessing, retrieve the tabular representation for this object, and handle multimedia objects (ObjectStore Object Managers).

ATKDataView, ATKTable, and ATKInstanceFormat let you access ObjectStore collections as tables.

ATKClass and ATKClassSlot provide high-level information about the database schema.

In this chapter
 This chapter documents the following ATK classes:

ATKClass

 ATKClass provides a high-level interface to the ATK metaknowledge. ATKClass retrieves information about the declaration of a class in the database schema, and can retrieve a class extent if the user defines that behavior in Inspector.

Methods
ATKClass contains these methods:
MethodDescription
GetClassExtent

Returns an ATKReferences object that contains the extent of the current class.

GetClassName

Returns the name of the class.
GetFatherClasses

Returns an ATKClasses object containing classes that are first-level ancestors of the current class.
GetMethods

Returns all the available user-defined methods registered for the current class.
GetSonClasses

Returns an ATKClasses object containing classes that are first-level derivations of the current class.
GetSlots

Returns an ATKClassSlots object that represents the attributes declared for the current class or its ancestors.
IsTopLevelClass

Checks if the class has ancestors.

ATKClass::GetClassExtent

ATKClass::GetClassExtent returns an ATKReferences object that contains the extent of the current class, as defined in Inspector.

ATKReferences GetClassExtent
Return value
 ATKReferences

Comments
GetClassExtent checks the metaknowledge to determine which roots and collections are defined as part of the extent of the class.

ATKClass::GetClassName

ATKClass::GetClassName returns the name of the class as it is declared in the database schema.

BSTR GetClassName
Return value
 A string containing the name of the represented class.

ATKClass::GetFatherClasses

ATKClass::GetFatherClasses returns an ATKClasses object. This collection contains first-level ancestor classes of the current class (that is, the classes from which this class directly inherits). 

ATKClasses GetFatherClasses
Return value
 ATKClasses

ATKClass::GetMethods

ATKClass::GetMethods () returns all the available user-defined methods registered for the current class.

Return value
ATKMethods

ATKClass::GetSonClasses

ATKClass::GetSonClasses returns an ATKClasses object. The classes in the ATKClasses collection are first-level derivations of the current class; that is, they inherit directly from the current class.

ATKClasses GetSonClasses
Return value
 ATKClasses

ATKClass::GetSlots

ATKClass::GetSlots returns an ATKClassSlots object, which is a collection of data members declared for the current class or its ancestors.

ATKClassSlots GetSlots
Return value
 ATKClassSlots

ATKClass::IsTopLevelClass

ATKClass::IsTopLevelClass checks if the class has ancestors.

Boo IsTopLevelClass
Return values
Return ValueDescription
TRUE

The class has no ancestors and is therefore a top-level class.
FALSE

The class has ancestors and is therefore not a top-level class.

ATKClasses

 ATKClasses is a collection of ATKClass objects.

Property
ATKClasses contains this property:
PropertyDescription
Count

Returns the number of objects in the collection.

Methods
ATKClasses contains these methods:
MethodDescription
Count

Returns the number of objects in the collection.
Item

Returns the specified item in the collection.

ATKClasses::Count

ATKClasses::Count returns the number of ATKClass objects in the ATKClasses collection.

long Count
Return value
 A long representing the number of objects.

ATKClasses::Item

ATKClasses::Item retrieves a specific ATKClass object from the collection.

ATKClass Item(
VARIANT  item)
Parameter
 Item accepts this parameter:
ParameterDescription
item

 Identifies an object in the collection.

A Long value specifies the position of the required object in the collection.

A BSTR value specifies the name of the object.

Return value
ATKClass

ATKClassSlot

ATKClassSlot represents a data member of a class. Use ATKClassSlot to retrieve information about the data members of the classes declared in the database schema.

Methods
ATKClassSlot contains these methods:
MethodDescription
GetAccess

Returns the attribute access type.
GetClass

Returns the name of the class in which the slot is declared.
GetName

Returns the attribute name.
GetRelationCardinality

Returns the cardinality of the relationship.
GetRelatedClass

Returns the ATKClass object of the related class.
GetType

Returns the attribute type.
IsRelation

Checks if an attribute is a relationship between two classes.

ATKClassSlot::GetAccess

ATKClassSlot::GetAccess returns the attribute access type for this data member, as it is declared in the database schema.

BSTR GetAccess
Return values
 GetAccess can return any of the following values:

ATKClassSlot::GetClass

 ATKClassSlot::GetClass returns the name of the class to which this data member belongs. 

BSTR GetClass
Return value
 A string containing the name of the class.

ATKClassSlot::GetName

ATKClassSlot::GetName returns the name of the data member as it is declared in the database schema. 

BSTR GetName
Return value
 A string containing the name of the data member.

ATKClassSlot::GetRelationCardinality

ATKClassSlot::GetRelationCardinality returns the cardinality of the relationship.

short GetRelationCardinality
Return values
 GetRelationalCardinality can return any of the following values:
Return ValueDescription
0

The data member is not a relationship.
1

The cardinality of the relationship is 1.
2

The cardinality of the relationship is many.

Comments
If this data member is a relationship between two classes, you can use GetRelationCardinality to retrieve its cardinality. To determine if the attribute is a relationship, GetRelationCardinality checks if the value of IsRelation is TRUE.

ATKClassSlot::GetRelatedClass

ATKClassSlot::GetRelatedClass returns the ATKClass object representing the class reached by navigating the relationship. 

ATKClass GetRelatedClass
Return value
 ATKClass

Comments
If this data member is a relationship between two classes, you can use GetRelatedClass to retrieve the class that is reached by navigating the relationship. GetRelatedClass first checks if the value of IsRelation is TRUE to determine if the attribute is a relationship.

ATKClassSlot::GetType

ATKClassSlot::GetType returns the data member type, as it is declared in the database schema. 

BSTR GetType
Return value
 A string containing the name of the data member type.

ATKClassSlot::IsRelation

ATKClassSlot::IsRelation checks the metaknowledge to determine whether the attribute is classified as a relationship between two classes. 

Bool IsRelation
Return values
 IsRelational can return the following values:
Return ValueDescription
TRUE

The data member is a relationship between two classes.
FALSE

The data member is not a relationship between two classes.

ATKClassSlots

ATKClassSlots is a collection of ATKClassSlot objects.

Property
ATKClassSlots contains this property:
PropertyDescription
Count

Returns the number of objects in the collection.

Methods
ATKClassSlots contains these method:
MethodDescription
Count

Returns the number of objects in the collection.
Item

Returns the specified item in the collection.

ATKClassSlots::Count

ATKClassSlots::Count returns the number of ATKClassSlot objects in the collection.

long Count
Return value
 A long representing the number of objects.

ATKClassSlots::Item

ATKClassSlots::Item retrieves a specific ATKClassSlot object from the collection.

ATKClassSlot Item(
VARIANT  item)
Parameter
 Item accepts this parameter:
ParameterDescription
item

 Identifies an object in the collection.

A Long value specifies the position of the required object in the collection.

A BSTR value specifies the name of the object.

Return value
ATKClassSlot

ATKDatabase

ATKDatabase represents an ObjectStore database, and provides access to all the operations you can perform on an ObjectStore database through ATK. To create an ATKDatabase object, you need an ATKKernel object. Using ATKDatabase, you can retrieve all available data views and roots and all the classes declared in the database schema, and set or retrieve default settings about ATK ActiveX behaviors.

Methods
ATKDatabase contains these methods:
MethodDescription
CreateObject

Invokes a registered user-defined method to create an instance of the specified class.
CreateObjectInSegment

Invokes a registered user-defined method to create an instance of the specified class.
GetAllClasses

Returns an ATKClasses object that lists the classes declared in the database schema.
GetClass

Returns the ATKClass represented by a specific class name.
GetInstanceFormat

Returns the instance format associated with a specific instance format name.
GetDataView

Returns the data view saved in Inspector using the specified name.
GetDataViews

Returns a list of all the data views defined in the database metaknowledge.
GetRoot

Returns the ATKRoot corresponding to a specific root name.
GetRoots

Returns a list of all the roots stored in the database.
SetJoinType

Specifies whether tables are returned in SQL-like or Inspector-like tabular format.

ATKDatabase::CreateObject

ATKDatabase::CreateObject invokes a registered user-defined method to create an instance of the specified class. ClassName contains the name of the class on which the create method MethodName has been defined and registered. Arguments is the map you use to specify the arguments needed to run MethodName.

ATKDatabase::CreateObject(
      BSTR ClassName,
      BSTR MethodName,
      ATKMethodArguments* Arguments)
Return value
 ATKReference

ATKDatabase::CreateObjectInSegment

ATKDatabase::CreateObjectInSegment invokes a registered user-defined method to create an instance of the specified class. ClassName contains the name of the class on which the create method MethodName has been defined and registered. Arguments is the map you use to specify the arguments needed to run MethodName. SegmentNumber specifies the number of the ObjectStore database segment in which the object should be persistently allocated.

ATKDatabase::CreateObjectInSegment(
      BSTR ClassName,
      BSTR MethodName,
      long SegmentName
      ATKMethodArguments* Arguments)
Return value
 ATKReference

ATKDatabase::GetAllClasses

ATKDatabase::GetAllClasses returns an ATKClasses object that lists the classes declared in the database schema. These are the same classes that Inspector displays in the schema representation.

ATKClasses GetAllClasses
Return value
 ATKClasses

Comments
GetAllClasses retrieves the list of declared classes from the metaknowledge, and the other information about classes from the database schema. You can use the returned ATKClasses object to iterate on all available classes.

ATKDatabase::GetClass

ATKDatabase::GetClass returns the ATKClass object with the name aClassName.

ATKClass GetClass(
BSTR  aClassName)
Parameter
 GetClass accepts this parameter:
ParameterDescription
aClassName

The name of the class you want to retrieve.

Return value
ATKClass

Comments
The parameter aClassName is case sensitive.

ATKDatabase::GetDataView

ATKDatabase::GetDataView returns an ATKDataView object that contains the data view saved as dataViewExpression in Inspector.

ATKDataView GetDataView(
BSTR  dataViewExpression)
Parameter
 GetDataView accepts this parameter:
ParameterDescription
dataViewExpression

Specifies the data view, as defined in the ATK metaknowledge. dataViewExpression can also contain an SQL command (following the syntax described in Chapter 3, Active Toolkit OLE DB Provider) that allows you to customize a data view.

Return value
ATKDataView

ATKDatabase::GetDataViews

ATKDatabase::GetDataViews returns an ATKDataViews object,which lists all the data views defined in the metaknowledge. 

ATKDataViews GetDataViews
Return value
 ATKDataViews

Comments
You can use the returned ATKDataViews object to iterate on all the available data views.

ATKDatabase::GetInstanceFormat

ATKDatabase::GetInstanceFormat returns the instance format associated in the metaknowledge with a specific instance format name.

ATKInstanceFormat GetInstanceFormat(
BSTR  instanceFormat)
Parameter
 GetInstanceFormat accepts this parameter:
ParameterDescription
instanceFormat

The name of the instance format that you want to access.

Return value
ATKInstanceFormat

ATKDatabase::GetRoot

ATKDatabase::GetRoot returns the ATKRoot corresponding to aRootname.

ATKRoot GetRoot(
BSTR aRootName)
Parameter
 GetRoot accepts this parameter:
ParameterDescription
aRootname

The name of the root as stored in the ObjectStore database.

Return value
ATKRoot

ATKDatabase::GetRoots

ATKDatabase::GetRoots returns an ATKRoots object that contains a collection of the roots stored in the database.

ATKRoot GetRoots
Return value
 ATKRoots

Comments
Use GetRoots to iterate on all the roots defined in the ObjectStore database.

ATKDatabase::SetJoinType

ATKDatabase::SetJoinType instructs ATK to use an SQL-like or Inspector-like tabular representation when displaying tables that allow navigation of one-to-many relationships.

void SetJoinType(
enumerator  joinType)
Parameter
 SetJoinType accepts this parameter:
ParameterDescription
joinType

 InspectorLike to use an Inspector-like join.

SQLLike to use an SQL-like join.

Comments
Use this field to override the default behavior of the ATK ActiveX server. For example, suppose you have two classes named Customer and Vehicle; a Customer might have several Vehicles.

If you specify InspectorLike, ATK expands one-to-many relationships in a tree-like way:
NameMakeModel
John, Smith

Ford

Escort


Cadillac

DeVille
Bob, Dylan

Ford

Ranger


Mazda

626


Dodge

Spirit

If you specify SQLLike, ATK expands one-to-many relationships to show all the possible values that meet the conditions of the query (as an SQL join would). The output takes this form:
NameMakeModel
John, Smith

Ford

Escort
Johh, Smith

Cadillac

DeVille
Bob, Dylan

Ford

Ranger
Bob, Dylan

Mazda

626
Bob, Dylan

Dodge

Spirit

ATKDataView

ATKDataView is the ATK ActiveX representation of a data view that has been defined in Inspector. Use ATKDataView to set the parameter values required by the filter, which is defined in the data view, and to execute the ObjectStore query on the underlying collection object.

ATKDataView works with three types of queries:

You can use ATKDataView to set the query parameters, if any, and then to jump to the ATKReferences or ATKTable query result.

Methods
ATKDataView contains these methods:
MethodDescription
GetAllParameters

Returns an ATKStrings object of strings that list the parameters in a query.
GetATKClass

Returns the class on which the data view is defined.
GetATKTable

Returns an ATKTable object that contains objects satisfying a query.
GetDataInstanceFormat

Returns the ATKInstanceFormat object associated with this data view.
GetDataInstanceFormatName

Returns an ATKInstanceFormat object associated with the data view.
GetName

Returns the name of the data view as defined in Inspector.
GetParameterPrompt

Returns the prompt to return to the client when specified values are retrieved.
GetParameterType

Returns the type of the parameter.
GetParameterValues

Retrieves specific values and returns them as strings.
IsFiltered

Checks if a query contains constraints.
IsFilterParameterized

Checks if a query contains constraints that must be fulfilled before the query is performed.
IsParameterList

Checks if a parameter value must be chosen from a list of values predefined by the query author.
IsParameterMultipleSelection

Checks if a parameter value must be chosen from a list of values that the query author has defined.
IsParameterSorted

Checks if the list of supplied values must be sorted.
PerformFiltering

Returns an ATKReferences object that lists the object satisfying the query constraints and parameters.
SetParameter

Sets the value of a parameter.

ATKDataView::GetAllParameters

ATKDataView::GetAllParameters returns an ATKStrings object that contains the names of all parameters used in the query, as defined in the data view.

ATKStrings GetAllParameters
Return value
 ATKStrings

ATKDataView::GetATKClass

ATKDataView::GetATKClass returns the class on which the data view is defined.

ATKClass* ATKDataView::GetATKClass( )

ATKDataView::GetATKTable

 ATKDataView::GetATKTable returns an ATKTable object containing a tabular representation of the data view. 

ATKTable GetATKTable[(
BSTR  instanceFormatName)]
Parameter
 GetATKTable accepts this parameter:
ParameterDescription
instanceFormatName

Optional. The name of the instance format, as defined in the metaknowledge, that ATK uses to format the table referenced by ATKDataView.

Return value
ATKTable

Comments
If instanceFormatName is an empty string ("") or is not supplied, ATK uses the default instance format for the class to which the elements of the referenced collection belong.

If the data view requires any filtering, GetATKTable executes the corresponding ObjectStore query. This is the most efficient means of accessing the tabular format of a data view through an ATKDataView object, and of filling in a table or list with representations of objects that satisfy a query.

ATKDataView::GetDataInstanceFormat

ATKDataView::GetDataInstanceFormat returns an ATKInstanceFormat object that contains the instance format associated with the data view in Inspector. 

ATKInstanceFormat GetDataInstanceFormat
Return value
 ATKInstanceFormat

ATKDataView::GetDataInstanceFormatName

ATKDataView::GetDataInstanceFormatName returns a string that contains the name of the instance format associated with the data view in Inspector. 

BSTR GetDataInstanceFormatName
Return value
 A string containing the name of the instance format.

ATKDataView::GetName

ATKDataView::GetName returns the name of the data view as defined in Inspector. 

BSTR GetName
Return value
 A string containing the name of the data view.

ATKDataView::GetParameterPrompt

ATKDataView::GetParameterPrompt returns the prompt that should be sent to the client when one or more of the parameter values is retrieved. The data view author defines the parameter values in Inspector.

BSTR GetParameterPrompt(
BSTR  parameterName)
Parameter
 GetParameterPrompt accepts this parameter:
ParameterDescription
parameterName

The name of the parameter for which you want to retrieve a prompt.

Return value
A string containing the prompt.

ATKDataView::GetParameterType

ATKDataView::GetParameterType returns the type of the parameter (such as string or number) of the attribute associated with the parameter.

BSTR GetParameterType(
BSTR  parameterName)
Parameter
 GetParameterType accepts this parameter:
ParameterDescription
parameterName

The name of the parameter whose type you want to retrieve.

Return values
GetParameterType can return the following values:

number

string

ATKDataView::GetParameterValues

ATKDataView::GetParameterValues returns an ATKStrings object that contains a collection of all acceptable values for the specified parameter.

ATKStrings GetParameterValues(
BSTR  parameterName)
Parameter
 ATKDataView::GetParameterValues accepts this parameter:
ParameterDescription
parameterName

The name of the parameter whose possible values you want to retrieve.

Return value
ATKStrings

Comments
Call this function and specify a parameter for which IsParameterList( parameterName) returns TRUE. If ATKDataView::IsParameterList is TRUE, GetParameterValues returns an ATKStrings object that contains all possible values of the parameter. GetParameterValues queries the ObjectStore database to retrieve all unique values of the data member associated with the specified parameter.

ATKDataView::IsFiltered

ATKDataView::IsFiltered checks if the ATKDataView object contains filter definitions on the ObjectStore collection it represents.

Bool IsFiltered
Return values
 IsFiltered can return the following values:
Return ValueDescription
TRUE

The data view contains constraints; that is, at least one filter is defined on the data view.
FALSE

The data view does not contain constraints; that is, there is no filter defined on the data view.

ATKDataView::IsFilterParameterized

ATKDataView::IsFilterParameterized checks if the data view that ATKDataView represents contains a filter that must be fully specified at execution time before the query is performed.

Bool IsFilterParameterized
Return values
 IsFilterParameterized can return the following values:
Return ValueDescription
TRUE

The data view contains at least one constraint that must be fully specified before the query is performed.

FALSE

The data view does not contain any constraints that must be fully specified before the query is performed.

ATKDataView::IsParameterList

ATKDataView::IsParameterList checks if the parameter can be assigned only to a value that the data view author has specified in Inspector.

Bool IsParameterList(
BSTR  parameterName)
Parameter
 IsParameterList accepts this parameter:
ParameterDescription
parameterName

The name of the parameter you want to check.

Return values
IsParameterList can return the following values:
Return ValueDescription
TRUE

The parameterName can be assigned only to a value that the data view author has specified in Inspector.
FALSE

The parameterName can be assigned to any value.

Comments
IsParameterList retrieves this information from the data view definition in the ATK metaknowledge.

ATKDataView::IsParameterMultipleSelection

ATKDataView::IsParameterMultipleSelection checks if the client can perform a multiple selection on the list of possible parameter values. 

Bool IsParameterMultipleSelection(
BSTR  parameterName)
Parameter
 IsParameterMultipleSelection accepts this parameter:
ParameterDescription
parameterName

The name of the parameter that you want to check.

Return values
IsParameterMultipleSelection can return the following values:
Return ValueDescription
TRUE

The client can specify multiple choices for the specified parameterName.

FALSE

The client can perform a single selection on the list of possible parameterName values.

Comments
When defining the query in Inspector, the data view author determines if a multiple selection or single selection is possible. IsParameterMultipleSelection retrieves this information from the data view definition in the metaknowledge.

ATKDataView::IsParameterSorted

ATKDataView::IsParameterSorted checks if the list of acceptable parameter values must be sorted. 

Bool IsParameterSorted(
BSTR  parameterName)
Parameter
 IsParameterSorted accepts this parameter:
ParameterDescription
parameterName

The name of the parameter that you want to check.

Return values
IsParameterSorted can return the following values:
Return ValueDescription
TRUE

The list of acceptable parameterName values must be sorted.

FALSE

The list of acceptable parameterName values does not require sorting.

Comments
When defining the data view in Inspector, the author determines if a sort will be required. IsParameterSorted retrieves this information from the data view definition in the metaknowledge.

ATKDataView::PerformFiltering

ATKDataView::PerformFiltering returns an ATKReferences object that contains a list of objects that satisfy the query and any constraints and/or parameters. 

ATKReferences PerformFiltering
Return value
 ATKReferences

Comments
If there is no filter defined for the data view, PerformFiltering returns the entire ObjectStore collection from the data view.

This is the simplest means of traversing a collection.

To retrieve the object representations rather than the objects themselves (for example, when filling a table), using ATKDataView::GetATKTable to return an ATKTable object is more efficient.

ATKDataView::SetParameter

ATKDataView::SetParameter sets the parameterName to the specified value before executing the query.

void SetParameter(
BSTR  parameterName, VARIANT  value)
Parameters
 SetParameter accepts these parameters:
ParameterDescription
parameterName

The name of the parameter whose value you want to set.
value

The value to which the parameter must be set.

Comments
SetParameter accepts different VARIANT types and translates each to the required parameter type. If parameterName accepts multiple selection, SetParameter accepts an array of values and binds the list of values to the parameterName.

ATKDataViews

 ATKDataViews is a collection of ATKDataView objects.

Property
ATKDataViews contains this property:
PropertyDescription
Count

Returns the number of objects in the collection.

Methods
ATKDataViews contains these methods:
MethodDescription
Count

Returns the number of objects in the collection.
Item

Returns the specified item in the collection.

ATKDataViews::Count

ATKDataViews::Count returns the number of ATKDataView objects in the collection. 

long Count
Return value
 A long representing the number of objects.

ATKDataViews::Item

ATKDataViews::Item retrieves a specific ATKDataView object from the collection.

ATKDataView Item(
VARIANT  item)
Parameter
 Item accepts this parameter:
ParameterDescription
item

 Identifies an object in the collection.

A Long value specifies the position of the required object in the collection.

A BSTR value specifies the name of the object.

Return value
ATKDataView

ATKInstanceFormat

ATKInstanceFormat stores information about a given instance format, as it was created in Inspector. Use ATKInstanceFormat to access the definition of an instance format that was defined in Inspector and is contained in the ATK metaknowledge. You can also retrieve the name of the instance format and the names of the column headers defined in the instance format.

Methods
ATKInstanceFormat contains these methods:
MethodDescription
GetFormatName

Returns the name of the instance format, as it was defined in Inspector.
GetHeaders

Returns a list of strings that represent the names of the column headers in a given instance format.

ATKInstanceFormat::GetFormatName

ATKInstanceFormat::GetFormatName returns the name of the instance format, as it is stored in the ATK metaknowledge. 

BSTR GetFormatName
Return value
 A string containing the name of the instance format.

ATKInstanceFormat::GetHeaders

ATKInstanceFormat::GetHeaders returns an ATKStrings object that contains the headers of the columns in the instance format.

ATKStrings GetHeaders
Return value
 ATKStrings

ATKKernel

ATKKernel is the main entry point to the ATK ActiveX object model. Use ATKKernel to open an ObjectStore database, to refresh the ATK metaknowledge (that is, to make ATK aware of any change you have made through Inspector), and to obtain an ATKReference object from a string representation of a persistent object. When you create an ATKKernel.Document ActiveX object, you actually obtain an ATKKernel object.

Methods
ATKKernel contains these methods:
MethodDescription
OpenDatabase

Opens a database.
ReloadMetaKnowledge

Causes the ActiveX server to refresh the metaknowledge for all cached databases.
ResolveReference

Returns an ATKReference object for a specific reference.

ATKKernel::OpenDatabase

ATKKernel::OpenDatabase opens the database specified by databaseName and returns an ATKDatabase object.

ATKDatabase OpenDatabase(
BSTR  databaseName [, BSTR  userName] [, BSTR  passWord]

[, BSTR  import])
Parameter
 OpenDatabase accepts these parameters:
ParameterDescription
databaseName

The full pathname of the database.
userName

Optional. The user name that ATK uses to access the ObjectStore client and connect to the ObjectStore database.
passWord

Optional. The password that ATK uses to access the ObjectStore client and connect to the ObjectStore database.
import

Optional. The name of the database from which ATK should import the metaknowledge.

Return value
ATKDatabase

Comments
The databaseName can contain any ObjectStore DB path:

ATKKernel::ReloadMetaKnowledge

void ReloadMetaKnowledge

ATKKernel::ResolveReference

 ATKKernel::ResolveReference returns an ATKReference object specified by reference. 

ATKReference ResolveReference(
BSTR  reference)
Parameter
Return value
ATKReference

Comments
An os_reference and its dumped representation identify a persistent object inside a database. Refer to the ObjectStore documentation for further details.

The reference must be in the same format as the object returned by os_reference::dump().

ResolveReference requires that the reference meet these conditions:

ATKMethod

 ATKMethod is used to retrieve information about a user-defined method.

Methods
ATKMethod exposes these methods:
MethodDescription
GetArguments

Returns a map of argument-name/argument-value that you can populate.
GetCategory()

Returns the category to which the user-defined method belongs.
GetClass()

Returns the name of the persistent class that defines the method.
GetName()

Returns the unmangled name of the registered user-defined method.
GetReturnType()

Returns the method type.
IsStatic()

Returns TRUE or FALSE based on whether or not the user-defined method is defined as static.
IsVirtual()

Returns TRUE or FALSE based on whether or not the user-defined method is defined as virtual.

ATKMethod::GetArguments()

ATKMethod::GetArguments returns a map of argument-name/argument-value that you can populate and pass to the function used to invoke the method. The map is returned with the proper keys filled, but with no associated values.

ATKMethodArguments GetArguments()
Return value
 ATKMethodArguments

ATKMethod::GetCategory()

ATKMethod::GetCategory returns the category name of the method.

BSTR GetCategory()
Return values
 GetCategory can return the following values:

ATKMethod::GetClass()

 ATKMethod::GetClass returns the name of the persistent class which defines the method.

BSTR GetClass()
Return value
 GetCategory returns a string representing the class name.

ATKMethod::GetName()

ATKMethod::GetName returns the unmangled name of the registered user-defined method.

BSTR GetName()
Return value
 GetCategory returns a string representing the user-defined method.

ATKMethod::GetReturnType()

ATKMethod::GetReturnType returns the method return type.

BSTR GetReturnType()
Return value
 GetReturnType can return the following values:

ATKMethod::IsStatic()

 ATKMethod::IsStatic returns TRUE or FALSE based on whether or not the user-defined method is defined as static.

Bool IsStatic
Return value
 IsStatic can return the following values:
Return ValueDescription
TRUE

The user-defined method is defined as static.
FALSE

The user-defined method is not defined as static.

ATKMethod::IsVirtual()

ATKMethods::IsVirtual returns TRUE or FALSE based on whether or not the user-defined method is defined as virtual.

Bool IsVirtual
Return value
 IsVirtual can return the following values:
Return ValueDescription
TRUE

The user-defined method is defined as virtual.
FALSE

The user-defined method is not defined as virtual.

ATKMethods

ATKMethods is a collection of ATKMethod objects.

Property
ATKMethods contains this property:
PropertyDescription
Count

Returns the number of objects in the collection.

Methods
ATKMethods contains these methods:
MethodDescription
Count

Returns the number of objects in the collection.
Item

Returns the specified item in the collection.

ATKMethods::Count

ATKMethods::Count returns the number of ATKMethod objects in the collection. 

long Count
Return value
 A long representing the number of objects.

ATKMethods::Item

ATKMethods::Item retrieves a specific ATKMethod object from the collection.

ATKMethod Item(
VARIANT  item)
Parameter
 Item accepts this parameter:
ParameterDescription
item

 Identifies an object in the collection.

A Long value specifies the position of the required object in the collection.

A BSTR value specifies the name of the object.

Return value
ATKMethod

ATKMethodArguments

ATKMethodArguments is a type of map used to pass arguments to user-defined methods. This class must be transiently created, which you can do

Methods
 ATKMethodArguments contains these methods:
MethodDescription
Add

Adds a key/value pair to the map.
Count

Returns the number of key/value pairs contained in the map.
Item

Returns the value associated with the specified key.
Remove

Removes the key/value pair associated with the specified key.

ATKMethodArguments::Add()

ATKMethodArguments::Add adds a key/value pair to the map.

void Add(BSTR key, VARIANT value)

ATKMethodArguments::Count()

 ATKMethodArguments::Count returns the number of key/value pairs contained in the map.

long Count()
Return value
 A long representing the number of objects.

ATKMethodArguments::Item()

ATKMethodArguments::Item returns the value associated with the specified key.

VARIANT Item(BSTR key)
Return value
 A VARIANTrepresenting the key value.

ATKMethodArguments::Remove()

ATKMethodArguments::Remove removes the key/value pair associated with the specified key.

Bool Remove (BSTR key)
Return values
 Remove can return the following values:
Return ValueDescription
TRUE

The operation was completed successfully.
FALSE

The operation was not completed successfully.

ATKObjectManager

ATKObjectManager is the ATK-ActiveX interface built on top of ObjectStore multimedia Object Managers. Use ATKObjectManager to retrieve information specific to an Object Manager and to access its data directly.

Call QueryInterface to obtain an IStream, and handle it as a standard COM stream.

Methods
ATKObjectManager contains these methods:
MethodDescription
GetDataArray

Returns a safe array containing the data associated with the Object Manager.
GetDataSize

Returns the length of the data field associated with the Object Manager.
GetOMMimeType

Returns the MIME type defined for this Object Manager.
GetOMTypeName

Returns the name of the ObjectManager that this object represents.
GetStream

Returns the IStream containing the data associated with the Object Manager.

ATKObjectManager::GetDataArray

ATKObjectManager::GetDataArray returns a safe array that contains the data associated with the Object Manager.

VARIANT GetDataArray
Return value
 VT_ARRAY|VT_UI1

GetDataArray returns an array of bytes that contains a copy of the multimedia Object Manager data.

ATKObjectManager::GetDataSize

ATKObjectManager::GetDataSize returns the length of the multimedia data field associated with the Object Manager.

long GetDataSize
Return value
 The numeric length of the multimedia field.

ATKObjectManager::GetOMMimeType

ATKObjectManager::GetOMMimeType returns the MIME type defined for this Object Manager.

BSTR GetOMMimeType
Return value
 A string containing the MIME type.

ATKObjectManager::GetOMTypeName

ATKObjectManager::GetOMTypeName returns the name of the multimedia ObjectManager type that this object represents.

BSTR GetOMTypeName
Return values
 GetOMMimeType can return the following values:

ATKObjectManager::GetStream

 ATKObjectManager::GetStream returns the IStream containing the data associated with the Object Manager.

IStream GetStream
Return value
 A stream interface.

Comments
Use GetStream to access the multimedia Object Manager data through an IStream interface.

ATKReference

An ATKReference object is the ATK ActiveX representation of a generic persistent ObjectStore object. Although ATKReference can refer to any persistent object, it determines if a specific object is an ObjectStore collection or an Object Manager. Using ATKReference, you can also retrieve an object's tabular representation and persistent data member values, including multimedia content.

Methods
ATKReference contains these methods:
MethodDescription
DeleteObject

Invokes a delete user-defined method on a persistent object.
GetATKDatabase

Returns an ATKDatabase object for the referenced object.
GetATKObjectManager

Returns an ATKObjectManager for the referenced object.
GetCardinality

Returns the cardinality of a collection; returns 1 otherwise.
GetCollectionItems

Traverses a collection and returns an ATKReferences object.
GetClass

Returns the ATKClass to which an object belongs.
GetReference

Returns the dumped os_reference representation of the referenced object.
GetRepresentation

Returns a string containing a flat representation of an object.
GetSlotValue

Returns the value of a specific attribute, or a generic ATKReference object.
GetTabularRepresentation

Returns lists of strings that represent the rows in a table.
IsCollection

Checks whether an object is a collection.
IsObjectManager

Checks whether an object is an Object Manager.

ReadObject

Invokes a read user-defined method on a persistent object.
UpdateObject

Invokes an update user-defined method on a persistent object.

ATKReference::DeleteObject

ATKReference::DeleteObject ( ) invokes a delete user-defined method on the persistent object represented by ATKReference. DeleteMethodName is the name of the delete method registered for the class to which the current ATKReference belongs.

Bool ATKReference::DeleteObject(
      BSTR  DeleteMethodName)
Return value
Return ValueDescription
TRUE

The user-defined method returned a non-zero value.
FALSE

The user-defined method returned a zero value.
s

ATKReference::GetATKDatabase

 ATKReference::GetATKDatabase returns an ATKDatabase object for the referenced object.

ATKDatabase GetATKDatabase
Return value
 ATKDatabase

Comments
GetATKDatabase is particularly useful if you use ATKKernel::ResolveReference to get an ATKReference object.

ATKReference::GetATKObjectManager

ATKReference::GetATKObjectManager returns an ATKObjectManager object for the referenced object. 

ATKObjectManager GetATKObjectManager
Return value
 ATKObjectManager

Comments
GetATKObjectManager works only if the persistent object referenced by ATKReference is an ObjectStore Object Manager object.

ATKReference::GetCardinality

ATKReference::GetCardinality returns the cardinality of a collection. 

long GetCardinality
Return values
 GetCardinality can return the following values:
Return ValueDescription
The collection cardinality

If the object that ATKReference refers to is an ObjectStore collection
1

The object is not an ObjectStore collection

ATKReference::GetCollectionItems

ATKReference::GetCollectionItems traverses a collection and returns an ATKReferences object that contains a collection of ATKReference objects. 

ATKReferences GetCollectionItems
Return value
 ATKReferences

Comments
GetCollectionItems works only if the persistent object referenced by ATKReference is an ObjectStore collection.

ATKReference::GetClass

ATKReference::GetClass returns the ATKClass to which an object belongs.

ATKClass GetClass
Return value
 ATKClass

Comments
GetClass joins the persistent objects and schema knowledge of the ATK object model. If the current ATKReference object refers to an instance of a class in the database schema, you can retrieve information about the declaration of that class by calling GetClass.

ATKReference::GetReference

ATKReference::GetReference returns the dumped os_reference representation of the referenced object.

BSTR GetReference
Return value
 The os_reference representation of the referenced object.

Comments
The return value is in os_reference::dump() format.

You can use the returned value when calling ATKKernel::ResolveReference.

ATKReference::GetRepresentation

ATKReference::GetRepresentation returns a string containing a flat representation of an object. 

BSTR GetRepresentation[(
BSTR  instanceFormatName)]
Parameter
 GetRepresentation accepts this parameter:
ParameterDescription
instanceFormatName

Optional. The name of the instance format from which you want to retrieve the object.

Return value
A string representation of the object.

Comments
If instanceFormat is "" (an empty string) or is not supplied, GetRepresentation uses the default instance format of the class to which the object belongs.

ATKReference::GetSlotValue

ATKReference::GetSlotValue returns the value of the data member attributeName from the persistent object.

VARIANT GetSlotValue(
BSTR  attributeName)
Parameter
 GetSlotValue accepts this parameter:
ParameterDescription
attributeName

The name of the data member whose value you want to retrieve.

Return values
VARIANT

If attributeName is a data member of the class to which the object referenced by ATKReference belongs, GetSlotValue returns a VARIANT.
Return ValueDescription
Long

If the data member specified by attributeName is a numeric integer data member, the VARIANT is a Long containing the value of the field.

Double

If the data member is a numeric floating-point data member, the VARIANT is a Double containing the value of the field.
BSTR

If the data member is a string, the VARIANT is a BSTR containing a copy of the value of the field.
ATKReference

If the data member is a relationship, the VARIANT is an ATKReference object representing the related objects.

Comments
The attributeName must be an attribute of the referenced object's class. GetSlotValue processes only the values of integer data member types (string and number) and of relationships.

ATKReference::GetTabularRepresentation

ATKReference::GetTabularRepresentation returns an ATKStringsList object, which contains a collection of strings that represent the rows in a table containing the referenced object. 

ATKStringsList GetTabularRepresentation[(
BSTR  instanceFormatName)]
Parameter
 GetTabularRepresentation accepts this parameter:
ParameterDescription
instanceFormatName

Optional. The name of the instance format, defined in the ATK metaknowledge, that ATK uses to format the object referenced by ATKReference.

Return value
ATKStringsList

For example, suppose ATKReference references a Customer instance, and the specified instance format instructs ATK to show the Customer name and the make and model of the cars the customer owns. The ATKStringsList object contains this output in tabular format:
NameMakeModel
John, Smith

Ford

Escort


Cadillac

DeVille

Comments
The data in the strings is presented according to the specified instanceFormatName, which indicates the navigation pattern of the data in the object. If instanceFormatName is "" (an empty string) or is not supplied, GetRepresentation uses the default instance format of the class to which the object belongs.

ATKReference::IsCollection

ATKReference::IsCollection checks if an object has been classified as a collection.

Bool IsCollection
Return values
 IsCollection can return the following values:
Return ValueDescription
TRUE

The object is an ObjectStore collection.
FALSE

The object is not an ObjectStore collection.

ATKReference::IsObjectManager

ATKReference::IsObjectManager checks if the object has been classified as an Object Manager (for example, image, video, audio, HTML). 

Bool IsObjectManager
Return values
 IsObjectManager can return the following values:
Return ValueDescription
TRUE

The object is an ObjectStore Object Manager.
FALSE

The object is not an ObjectStore Object Manager.

ATKReference::ReadObject

ATKReference::ReadObject ( ) invokes a read user-defined method on the persitent object represented by ATKReference. ReadMethodName is the name of the read method registered for the class to which the current ATKReference belongs.

VARIANT ATKReference::ReadObject(
      BSTR  ReadMethodName)
Return value
 The function returns the value returned by the invoked user-defined method. The type of the returned value varies according to the user-defined method that is called.

ATKReference::UpdateObject

ATKReference::UpdateObject ( ) invokes an update user-defined method on the persitent object represented by ATKReference. UpdateMethodName is the name of the update method registered for the class to which the current ATKReference belongs. Arguments is a map of argument-name/argument-value pairs used to pass arguments to the method.

Bool ATKReference::UpdateObject(
      BSTR  UpdateMethodName,
      IATKMethodArguments* Arguments)
Return values
 UpdateObject can return the following values:
Return ValueDescription
TRUE

The user-defined method returned a non-zero value.
FALSE

The user-defined method returned a zero value.

ATKReferences

ATKReferences is a collection of ATKReference objects. Because this class is the ATK equivalent of an ObjectStore collection, you can use an ATKReferences object to retrieve all the items contained in the underlying ObjectStore collection, and to create ATKDataView and ATKTable objects based on the same collection.

Property
ATKReferences contains this property:
PropertyDescription
Count

Returns the number of objects in the collection.

Methods
ATKReferences exposes these methods:
MethodDescription
Add

Adds a single persistent object, or a collection of persistent objects to the current ATKReferences object.
GetATKDataView

Returns an ATKDataView associated with the dataViewExpression.
GetATKTable

Returns an ATKTable associated with the instanceFormatName.
Item

Returns the specified item in the collection.

Remove

Removes a single persistent object, or a collection of persistent objects from the current ATKReferences object.

ATKReferences::Add

ATKReferences::Add adds a single persistent object represented by ATKReference, or a collection of persistent objects contained in the ItemCollection set, to the current ATKReferences object.

ATKReferences::Add(ATKReference* Item)
ATKReferences::Add(ATKReferences* ItemCollection)
Comments
 The ATKReferences instance on which these methods are invoked must be transiently allocated. Such instances can be built using the Visual Basic new operator or with CreateObject. An error is thrown if the ATKReferences is not transiently allocated.

ATKReferences::Count

ATKReferences::Count returns the number of ATKReference objects contained in the collection.

long Count
Return value
 A long representing the number of objects.

ATKReferences::GetATKDataView

ATKReferences::GetATKDataView returns an ATKDataView object that contains the data view definition specified by dataViewExpression. 

ATKDataView GetATKDataView(
BSTR  dataViewExpression)
Parameter
 GetATKDataView accepts this parameter:
ParameterDescription
dataViewExpression

The data view, as defined in the ATK metaknowledge, that ATK opens on top of the collection referenced by ATKReferences.

Return value
ATKDataView

Comments
The dataViewExpression parameter can also contain an SQL command that follows the syntax described in Chapter 3, Active Toolkit OLE DB Provider.

ATKReferences::GetATKTable

ATKReferences::GetATKTable returns an ATKTable object in the specified instanceFormatName. 

ATKTable GetATKTable[(
BSTR  instanceFormatName)]
Parameter
 GetATKTable accepts this parameter:
ParameterDescription
instanceFormatName

 Optional. The name of the instance format, as defined in the ATK metaknowledge, that ATK uses to format the table referenced by ATKReferences.

Return value
ATKTable

Comments
If instanceFormatName is "" (an empty string) or is not supplied, ATKReferences::GetATKTable uses the default instance format for the class.

This is the most efficient means of accessing the tabular format of a collection through an ATKReferences object.

ATKReferences::Item

ATKReferences::Item retrieves a specific ATKReference object from the collection.

ATKReference Item(
VARIANT  item)
Parameter
 Item accepts this parameter:
ParameterDescription
item

Specifies the position of the object in the collection.

Return value
ATKReference

ATKReferences::Remove

ATKReferences::Remove ( ) removes a single persistent object represented by ATKReference, or a collection of persistent objects contained in the ItemCollection set, to the current ATKReferences object.

ATKReferences::Remove(ATKReference* Item)
ATKReferences::Remove(ATKReferences* ItemCollection)
Return value
 Remove can return the following values:
Return ValueDescription
TRUE

The function is successfully completed.
FALSE

The function does not complete successfully.

Comments
The ATKReferences instance on which these methods are invoked must be transiently allocated. Such instances can be built using the Visual Basic new operator or with CreateObject. An error is thrown if the ATKReferences is not transiently allocated.

ATKRoot

ATKRoot provides access to the ObjectStore roots defined in a database. By using an ATKRoot object, you can directly access the persistent objects.

Methods
ATKRoot contains these methods:
MethodDescription
GetATKReference

Returns the ATKReference object associated with the root.
GetATKTable

Returns the ATKTable representing a collection.
GetName

Returns the name of the root.
GetReference

Returns a string that contains the value associated with the root.

ATKRoot::GetATKReference

ATKRoot::GetATKReference returns the ATKReference object that represents the persistent object associated with the root.

ATKReference GetATKReference
Return value
 ATKReference

ATKRoot::GetATKTable

ATKRoot::GetATKTable returns the ATKTable object that represents the ObjectStore collection associated with the referenced root, in the specified instance format. 

ATKTable GetATKTable[(
BSTR  instanceFormatName)]
Parameter
 GetATKTable accepts this parameter:
ParameterDescription
instanceFormatName

Optional. The name of the instance format, as defined in the metaknowledge, that ATK uses to format the table.

Return value
ATKTable

Comments
If you know that the persistent object associated with the root is an ObjectStore collection, use this function to create an ATKTable object containing the tabular representation of the collection.

If instanceFormatName is "" (an empty string) or is not supplied, GetATKTable uses the default instance format for the class to which the items in the collection belong.

ATKRoot::GetName

ATKRoot::GetName returns the symbolic name of the root, as it is stored in the ObjectStore database.

BSTR GetName
Return value
 A string that contains the name of the root.

ATKRoot::GetReference

ATKRoot::GetReference returns a string representation of the persistent object associated with the root.

BSTR GetReference
Return value
 A string in os_reference::dump() format that contains the value of the persistent object.

ATKRoots

ATKRoots is a collection of ATKRoot objects.

Property
ATKRoots contains this property:
PropertyDescription
Count

Returns the number of objects in the collection.

Methods
ATKRoots contains these methods:
MethodDescription
Count

Returns the number of objects in the collection.
Item

Returns the specified item in the collection.

ATKRoots::Count

ATKRoots::Count returns the number of ATKRoot objects in the collection.

long Count
Return value
 A long representing the number of objects.

ATKRoots::Item

ATKRoots::Item retrieves a specific ATKRoot object from the collection.

ATKRoot Item(
VARIANT  item)
Parameter
 Item accepts this parameter:
ParameterDescription
item

 Identifies an object in the collection.

A Long value specifies the position of the required object in the collection.

A BSTR value specifies the name of the object.

Return value
ATKRoot

ATKStrings

ATKStrings is a collection of BSTR object types.

Property
ATKStrings contains this property:
PropertyDescription
Count

Returns the number of objects in the collection.

Methods
ATKStrings contains these methods:
MethodDescription
Count

Returns the number of objects in the collection.
Item

Returns the specified item in the collection.

ATKStrings::Count

ATKStrings::Count returns the number of BSTR values in the collection.

long Count
Return value
 A long representing the number of string objects.

ATKStrings::Item

ATKStrings::Item retrieves a specific BSTR value from the collection.

BSTR Item(
VARIANT  item)
Parameter
 Item accepts this parameter:
ParameterDescription
item

Specifies the position of the required string in the collection.

Return value
A string value.

ATKStringsList

ATKStringsList is a collection of ATKStrings objects.

Property
ATKStringsList contains this property:
PropertyDescription
Count

Returns the number of objects in the collection.

Methods
ATKStringsList exposes these methods:
MethodDescription
Count

Returns the number of objects in the collection.
Item

Returns the specified item in the collection.

ATKStringsList::Count

ATKStringsList::Count returns the number of ATKStrings objects in the collection.

long Count
Return value
 A long representing the number of string objects.

ATKStringsList::Item

ATKStringsList::Item retrieves a specific ATKStrings object from the collection.

ATKStrings Item(
VARIANT  item)
Parameter
 Item accepts this parameter:
ParameterDescription
item

Specifies the position of the required list of strings in the collection.

Return value
ATKStrings

ATKTable

ATKTable is a collection of objects that corresponds to the underlying ObjectStore collection. An ATKTable object is strictly related to the instance format used to create it.

ATKTable provides two kinds of string representations for an object:

You can use an ATKTable object to retrieve the content of the ObjectStore collection. For each object in the collection, you can retrieve the rows corresponding to its tabular representation in the instance format you specify. ATKTable also provides an easy, efficient means of adding data to a table using representations of the objects contained in a collection.

Methods
ATKTable contains these methods:
MethodDescription
GetCardinality

Returns the cardinality of a collection.
GetHeaders

Returns a list of the column headers in the instance format.
GetObject

Returns the ATKReference object that the ATKTable cursor points to.
GetReference

Returns the reference string representation of the object that the ATKTable cursor points to.
GetRepresentation

Returns the flat representation of the object that the ATKTable cursor points to.
GetTabularRepresentation

Returns lists of strings that represent the rows in a table associated with the object that the ATKTable cursor points to.
GetWholeHTML

Returns a string containing the default HTML representation of the entire table.
GetWholeXML

Returns a buffer containing the complete XML representation of the table.
IsBOT

Checks if the ATKTable cursor has reached the beginning of the collection.
IsEOT

Checks if the ATKTable cursor has reached the end of the collection.
MoveFirst

Moves the ATKTable cursor to the first item in the collection.
MoveLast

Moves the ATKTable cursor to the last item in the collection.
MoveNext

Moves the ATKTable cursor to the next item in the collection.
MovePrevious

Moves the ATKTable cursor to the previous item in the collection.
MoveTo

Moves the ATKTable cursor to a specific position in the collection.

ATKTable::GetCardinality

ATKTable::GetCardinality returns the cardinality of the collection. 

long GetCardinality
Return value
 The number of objects in the collection.

Comments
Because GetTabularRepresentation can return more than one row per object, GetCardinality might return a value that is smaller than the actual number of rows in the table.

ATKTable::GetHeaders

ATKTable::GetHeaders returns an ATKStrings object that contains a list of strings that are the column headers in the instance format.

ATKStrings GetHeaders
Return value
 ATKStrings

ATKTable::GetObject

ATKTable::GetObject returns the ATKReference object representing the persistent object that the ATKTable cursor points to.

ATKReference GetObject
Return value
 ATKReference

ATKTable::GetReference

ATKTable::GetReference returns the reference string representation of the object that the ATKTable cursor points to.

BSTR GetReference
Return value
 A string in os_reference::dump() format that contains the value of the persistent object.

ATKTable::GetRepresentation

ATKTable::GetRepresentation returns the flat representation of the object that the ATKTable cursor points to.

BSTR GetRepresentation
Return value
 A string representation of the table.

Comments
ATKTable::GetRepresentation uses the instance format associated with the ATKTable object to compute this representation.

ATKTable::GetTabularRepresentation

ATKTable::GetTabularRepresentation returns a list of strings that represent the object that the ATKTable cursor points to. GetTabularRepresentation presents the data in the strings according to the specified instanceFormat, which indicates the navigation pattern of the data in the object. 

ATKStringsList GetTabularRepresentation
Return value
 ATKStringsList

The collection of collections of strings contains the tabular representation of the current table object. For example, the return value could be a matrix:
NameMakeModel
John, Smith

Ford

Escort


Cadillac

DeVille

ATKTable::GetWholeHTML

ATKTable::GetWholeHTML returns a string containing the default representation of the entire HTML table. You can display the table in a web browser.

BSTR GetWholeHTML
Return value
 A string representation of the entire table in HTML.

Comments
Use GetWholeHTML to retrieve an HTML version of the table. Because GetWholeHTML returns a BLOB containing the entire table, Object Design recommends that you use this method as a prototype tool, and on tables that contain only a small sample of data.

ATKTable::GetWholeXML

ATKTable::GetWholeXML returns a buffer containing the complete XML representation of the table.

BSTR ATKTable::GetWholeXML
Return value
 A string representation of the entire table in HTML.

Comments
Use GetWholeXML to retrieve an HTML version of the table. Because GetWholeXML returns a BLOB containing the entire table, Object Design recommends that you use this method as a prototype tool, and on tables that contain only a small sample of data.

ATKTable::IsBOT

ATKTable::IsBOT checks if the ATKTable cursor is at the first object in the collection.

Bool IsBOT
Return values
 IsBot can return the following values:
Return ValueDescription
TRUE

The ATKTable cursor is at the first object in the collection.
FALSE

The ATKTable cursor is located in the collection but not at the first object.

ATKTable::IsEOT

ATKTable::IsEOT checks if the ATKTable cursor is at the last object in the collection.

Bool IsEOT
Return values
 IsEot can return the following values:
Return ValueDescription
TRUE

The ATKTable cursor is at the last object in the collection.
FALSE

The ATKTable cursor is located in the collection but not at the last object.

ATKTable::MoveFirst

ATKTable::MoveFirst moves the ATKTable cursor to the first object in the collection. 

void MoveFirst
Comments
 By default, the ATKTable cursor starts in this position.

ATKTable::MoveLast

ATKTable::MoveLast moves the ATKTable cursor to the last object in the collection.

void MoveLast

ATKTable::MoveNext

 ATKTable::MoveNext moves the ATKTable cursor to the next object in the collection.

void MoveNext

ATKTable::MovePrevious

 ATKTable::MovePrevious moves the ATKTable cursor to the previous object in the collection.

void MovePrevious

ATKTable::MoveTo

 ATKTable::MoveTo moves the ATKTable cursor to a specific object in the collection.

void MoveTo(
long  position)
Parameter
 MoveTo accepts this parameter:
ParameterDescription
position

The object number to which you want to move the table cursor. The first object in a collection is numbered 0.



[previous] [next]

Copyright © 1998 Object Design, Inc. All rights reserved.

Updated: 05/11/99 11:43:36