Function tip_FirstDocument
|
|
Prototype: | tip_FirstDocument(Collection);
|
---|
Arguments: | Collection: A Collection object. (CDM_Collection)
|
---|
|
|
Description:
This function will return a Document object representing the first
Document of the specified Collection. It can be used in order
to start an iteration over all Documents of the Collection. This
function will return the first Document in the given Collection and make
the proper arrangements so as subsequent calls to tip_NextDocument
return the following Documents.
Return Value:
This function returns a Document object (of type CDM_Document) that can
be used as a reference to all functions that require a Document object
as input. This object will be valid until the Collection that holds this
Document object is closed (through tip_Close) and the parent Collection
removed from memory. If this object is used after its parent Collection
has been closed, an undefined behaviour will occur. If an error occurs, then an error message will prompt.
*
Notes:
This function is equivelant to CDM_FirstDocument (C++ API).
See Also:
tip_Close, tip_NextDocument
Generated by: petasis@aias on Wed Aug 16 10:31:45 PM EEST 2006.