All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ENOVaultClientCPP Class ENOVIVaultResultSet

ENOVIVaultResultSet
 

Usage: you must use this class as is. You should never derive it.


public class ENOVIVaultResultSet

This class supplies methods to read collections of document.
role: In combination with the cache mechanism, it provides significants performance improvements when reading collection of documents


Constructor and Destructor Index


o ENOVIVaultResultSet()
Default constructor
o ENOVIVaultResultSet(int,ENOVIVaultUserSession*,ENOVIVaultReadIterator*,CATBoolean)
Constructs a result set.
o ~ENOVIVaultResultSet()
Destructor

Method Index


o close()
Terminates the read operation.
o next(ENOVIVaultDocument**,ENOVIVaultError&)
Fetches the next document to read.

Constructor and Destructor


o ENOVIVaultResultSet
public ENOVIVaultResultSet()
Default constructor
o ENOVIVaultResultSet
public ENOVIVaultResultSet(int invFetchSize,
ENOVIVaultUserSession* ipFatherUserSession,
ENOVIVaultReadIterator* ipDocReadIterator,
CATBoolean ibvAddDocToColl= TRUE)
Constructs a result set.
Parameters:
invFetchSize
[in] - fetch size.
ipFatherUserSession
[in] - Vault Client father user session.
ipDocReadIterator
[in] - Vault Document collection first fetch.
o ~ENOVIVaultResultSet
public virtual ~ENOVIVaultResultSet()
Destructor

Methods


o close
public HRESULT close()
Terminates the read operation.
o next
public HRESULT next(ENOVIVaultDocument** oNextDoc,
ENOVIVaultError& oVaultError)
Fetches the next document to read.
Parameters:
oNextDoc
[out] - Next Document to read, NULL if no more documents available.

This object is included in the file: ENOVIVaultResultSet.h
If needed, your Imakefile.mk should include the module: ENOVIVaultClientAPP

Copyright © 2003, Dassault Systèmes. All rights reserved.