GetDocumentEx

Returns the definition of a document, as well as other properties such as the document’s type, file type, and security class.

Syntax

<HFMwManageDocuments>.GetDocumentEx (bstrPath, bstrName, lDocumentType, lDocumentFileType, pvarbstrDescription, pvarbstrSecurityClass, pvarbPrivate, pvbstrOwner, pvdTimestamp, pvlFolderContentType)

Argument

Description

bstrPath

The path to the document.

Input argument. String subtype.

bstrName

The name of the document.

Input argument. String subtype.

lDocumentType

Identifies the type of document to return. Valid values are represented by the HFMConstants type library constants listed in Document Type Constants.

Input argument. Long subtype.

lDocumentFileType

Identifies the file type of the documents to return. Valid values are represented by the HFMConstants type library constants listed in Document File Type Constants.

Input argument. Long subtype.

pvarbstrDescription

Returns the description of the document.

Input/output argument.

pvarbstrSecurityClass

Returns the ID of the document’s security class.

Input/output argument.

pvarbPrivate

Indicates whether the document is public or private. TRUE indicates private, FALSE indicates public.

Input/output argument.

pvbstrOwner

Returns the username of the document’s owner.

Input/output argument.

pvdTimestamp

Returns the document’s timestamp. The timestamp can be converted to a Date format; for example, in VBScript you can convert with CDate.

Input/output argument.

pvlFolderContentType

Returns the type of document that a folder document can contain. This value has meaning only if the document is a folder; ignore this value for non-folder documents.

Valid values are represented by the HFMConstants type library constants listed in Document Type Constants.

Input/output argument.

Return Value

Returns the document’s definition.