GetDocumentEx

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

Syntax

<HsvReports>.GetDocumentEx(bstrPath, bstrName, lDocumentType, lDocumentFileType, pbstrDescription, plSecurityClass, pvbIsPrivate, pbstrDocOwner, pdTimestamp, plFolderContentType)

Argument

Description

bstrPath

String (ByVal). The path to the document.

bstrName

String (ByVal). The name of the document.

lDocumentType

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

lDocumentFileType

Long (ByVal). 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.

pbstrDescription

String. Returns the description of the document.

plSecurityClass

Long. Returns the ID of the document’s security class.

pvbIsPrivate

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

pbstrDocOwner

String. Returns the username of the document’s owner.

pdTimestamp

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

plFolderContentType

Long. 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.

Return Value

Variant. Returns the document’s definition.