Description

Returns an object that contains all the document objects that are in the specified states.

Syntax

Function FilterByWorkflowStates(WorkflowStates() As Object) As Object()

Parameters

Name

Data Type

Description

WorkflowStates

Array of String or Integers

An Array of Workflow State ID's or Workflow State Alias

Return

Returns a RelatedDocuments object. See RelatedDocuments object for more details.

Example

'create Pentagon DOCS Script Library object

Set scriptLib = GetExtensionObject("PentagonDOCS.Core.ScriptLibrary")


'get related documents

Set relatedDocs = scriptLib.GetRelatedDocuments(Vault, "ExDOCS.Property.BaseDocumentNumber", "P001-EXC-ZZ-00-DR-A-0001")


'filter by workflow state

Set result = relatedDocs.FilterByWorkflowStates(Array("ExDOCS.State.Shared", "ExDOCS.State.Published"))