EnumDocuments

Enumerates the names of the documents that match the specified criteria, as well as the documents’ descriptions, timestamps, and security classes.

This information is returned in arrays that have a one-to-one correspondence with each other.

Tip:	EnumDocumentsEx is a similar method that returns additional information such as the documents’ owners and document types.

Syntax

<HFMwManageDocuments>.EnumDocuments (bstrPath, lDocumentType, lDocumentFileType, vbFilterByCurrentUserOnly, vbFilterByCreateTime, dStartTime, dStopTime, pvarabstrDescriptions, pvaradTimestamp, pvarabstrSecurityClass)

Argument	Description
bstrPath	The document repository folder that contains the documents. Input argument. String subtype.
lDocumentType	The document type of the documents to be enumerated. Document types are represented by the HFMConstants type library constants listed in Document Type Constants. Input argument. Long subtype.
lDocumentFileType	The file type of the documents to be enumerated. File types are represented by the HFMConstants type library constants listed in Document File Type Constants. Input argument. Long subtype.
vbFilterByCurrentUserOnly	Specifies whether to enumerate only those documents that were created by the current user. Pass TRUE to enumerate only the current user’s documents, FALSE otherwise. Input argument.
vbFilterByCreateTime	Specifies whether information will be returned for only those documents with timestamps in a specified range. Pass TRUE to filter by timestamp, FALSE otherwise. If you pass TRUE, information will be returned for only those documents with timestamps that fall into the range specified by the dStartTime and dStopTime arguments. Note: If you pass FALSE, the dStartTime and dStopTime arguments will be ignored, but will still require a value. Input argument.
dStartTime	The beginning of the timestamp filtering range. Tip: To make the beginning of the range open-ended, pass 0 (zero). Input argument. Double subtype.
dStopTime	The end of the timestamp filtering range. Tip: To make the end of the range open-ended, pass 0 (zero). Input argument. Double subtype.
pvarabstrDescriptions	Returns an array of the documents’ descriptions. Output argument.
pvaradTimestamp	Returns an array of the documents’ timestamps. Output argument.
pvarabstrSecurityClass	Returns an array of the documents’ security classes. Output argument.

Return Value

Returns an array of the documents’ names.

Example

EnumDocuments is used in the example for DeleteDocuments.