Class Definition File | SUCursor.idl |
Class C++ Binding | SUCursor.xh |
Class Hierarchy |
SOMObject ODObject ODStorageUnitCursor |
Description | An object of the ODStorageUnitCursor class provides swift focusing on frequently accessed data in a storage unit. A storage-unit cursor represents a focus context for a storage unit. The focus context can be the entire storage unit, a particular property, or a particular value of a particular property. When the focus context is the entire storage unit, the data of interest includes all properties and all their values. When the focus context is a particular property, the data of interest includes all values of that property. When the focus context is a particular value, the data of interest is the data stream corresponding to that value. A storage-unit cursor uses a property name, a value type, and a value index to specify its focus context. Methods of the storage-unit cursor allow you to get and set each of these three pieces of information.
A storage-unit cursor makes it simple for you to focus the storage unit on the corresponding focus context. Your part creates a storage-unit cursor object by calling its storage unit's CreateCursor or CreateCursorWithFocus methods. Your part calls its storage unit's FocusWithCursor method to focus the storage unit on the focus context represented by a storage-unit cursor. For more information about storage units, focus context, and value indexes, see the class description for ODStorageUnit. |
Methods | The methods defined by the ODStorageUnitCursor class include: |
Overridden Methods | There are no methods overridden by the ODStorageUnitCursor class. |
This method gets the property name of this storage-unit cursor.
Signature
void GetProperty (ODPropertyName *propertyName) |
Parameters
Returns
None.
Remarks
When you no longer need the property name returned in the propertyName parameter, you should deallocate it.
Related Methods
This method gets the value index of this storage-unit cursor.
Signature
void GetValueIndex (ODValueIndex *valueIndex) |
Parameters
Returns
None.
Related Methods
This method gets the value type of this storage-unit cursor.
Signature
void GetValueType (ODValueType *valueType) |
Parameters
Returns
None.
Remarks
When you no longer need the value type returned in the valueType parameter, you should deallocate it.
Related Methods
This method sets the property name of this storage-unit cursor.
Signature
void SetProperty (ODPropertyName propertyName) |
Parameters
Returns
None.
Remarks When you no longer need the property name you pass as the propertyName parameter, you should deallocate it.
Related Methods
This method sets the value index of this storage-unit cursor.
Signature
void SetValueIndex (ODValueIndex valueIndex) |
Parameters
Returns
None.
Remarks
When you use this storage-unit cursor to focus your part's storage unit, the value index of this storage-unit cursor is ignored unless the value type is kODNULL.
Related Methods
This method sets the value type of this storage-unit cursor.
Signature
void SetValueType (ODValueType valueType) |
Parameters
Returns
None.
Remarks
When you no longer need the value type you pass as the valueType parameter, you should deallocate it.
Related Methods