createDocumentEnumerator( )

Creates a document enumerator.

Interface

PODSDocumentSrc

IDL definition
PODSDocumentEnumerator createDocumentEnumerator();
JavaScript synopsis

Not applicable

C synopsis
PODSDocumentEnumerator* PODScreateDocumentEnumerator(
  PODSDocumentSrc* docsrc
);
Parameters
  • docsrc   The PODSDocumentSrc object.

Returns

PODSDocumentEnumerator object for the PODSDocumentSrc object.

Remarks

Your document source can optionally implement this method, or your own implementation of it, if you would like it to provide enumeration of the documents that it can provide. Document enumeration allows the M-Business Client's Find to locate matching documents.

The PODSDocumentSrc implementation of createDocumentEnumerator( ) enumerates only a single document source, while the PODSDocumentMgr implementation enumerates all documents from all registered document sources.

See also

PODSDocumentMgr object's createDocumentEnumerator( )