CreateCursor

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods / ODStorageUnit

CreateCursor
The CreateCursor method creates a storage-unit cursor representing the specified focus context for this storage unit.
ODStorageUnitCursor CreateCursor (
                           in ODPropertyName propertyName, 
                           in ODValueType valueType, 
                           in ODValueIndex valueIndex);
propertyName
The name of the property in the focus context, or kODNULL if the focus context is the entire storage unit.
valueType
The value type of the value in the focus context, or kODNULL to ignore this parameter.
valueIndex
The value index of the value in the focus context, or 0 to ignore this parameter.
return value
A reference to the newly created storage-unit cursor.

DISCUSSION
Your part calls this method; its parameters specify the focus context for the storage-unit cursor.

To specify the entire storage unit as the focus context, pass kODNULL as the property name, kODTypeAll as the value type parameter, and kODIndexAll as the value index parameter.
To specify a property as the focus context, pass its name as the property name parameter, kODTypeAll as the value type parameter, and kODIndexAll as the value index parameter.
To specify a value as the focus context, pass the name of the property containing the value as the property name parameter. You can specify the value by either its type or its index:

To use type, pass the type of the desired value as the value type parameter and 0 as the value index parameter.
To use index, pass kODNULL as the value type parameter and the index of the desired value as the value index parameter.

EXCEPTIONS

kODErrZeroRefCount
This storage unit has a reference count of 0.

SEE ALSO
The ODPropertyName type (page 904).
The ODValueIndex type (page 904).
The ODValueType type (page 904).
The ODStorageUnit::CreateCursorWithFocus method (page 677).
The ODStorageUnitCursor class (page 716).
Table 11-1 on page 466 in OpenDoc Programmer's Guide.