MoveDocumentsThroughWorkFlow Method

Description

This method moves the specified file (and optionally its drafts and revisions) to the specified status.

Syntax

Visual Basic
Public Function MoveDocumentsThroughWorkFlow( _ ByVal FileName As String, _ ByVal newstatus As DocumentStatus, _ Optional ByVal NumberOfDraftFiles As Variant, _ Optional ByVal draftFileList As Variant, _ Optional ByVal draftFileStatusList As Variant, _ Optional ByVal NumberOfRevisionFiles As Variant, _ Optional ByVal revisionFileList As Variant, _ Optional ByVal RevisionFileStatusList As Variant _ ) As Long

Visual Basic

Public Function MoveDocumentsThroughWorkFlow( _
   ByVal FileName As String, _
   ByVal newstatus As DocumentStatus, _
   Optional ByVal NumberOfDraftFiles As Variant, _
   Optional ByVal draftFileList As Variant, _
   Optional ByVal draftFileStatusList As Variant, _
   Optional ByVal NumberOfRevisionFiles As Variant, _
   Optional ByVal revisionFileList As Variant, _
   Optional ByVal RevisionFileStatusList As Variant _
) As Long

Parameters

FileName

Specifies the URL path of the file to be assigned a new status.

newstatus

Value	Description
igStatusAvailable
igStatusBaselined
igStatusInReview
igStatusInWork
igStatusObsolete
igStatusReleased

Member of the DocumentStatus constant set that specifies the new status of the file.

NumberOfDraftFiles

Specifies the number of associated draft files.

draftFileList

Specifies the associated draft files.

draftFileStatusList

Specifies the new status list for the draft files.

NumberOfRevisionFiles

Specifies the number of associated revision files.

revisionFileList

Specifies the associated revision files.

RevisionFileStatusList

Specifies the new status list for the revision files.

Example

Example (VB.NET)

Imports RevisionManager
Imports System.Runtime.InteropServices

Module Example

    Sub Main()
        Dim objApplication As RevisionManager.Application = Nothing
        Dim objInsight As RevisionManager.Insight = Nothing
        Dim DocumentStatus As RevisionManager.DocumentStatus
        Dim strFileName As String
        Dim aDraftFileList(1) As Object
        Dim aDraftFileStatusList(1) As Object
        Dim aRevisionFileList(1) As Object
        Dim aRevisionFileStatusList(1) As Object

        Try
            ' Start Revision Manager.
            objApplication = New RevisionManager.Application

            ' Get reference to Insight object.
            objInsight = objApplication.Insight

            strFileName = "http://solidvm/Engineering/PreReleased/PreReleasedDocLib/CDPlayer/CDPlayer.asm"
            DocumentStatus = DocumentStatus.igStatusAvailable
            aDraftFileList(0) = "http://solidvm/Engineering/PreReleased/PreReleasedDocLib/CDPlayer/test1.dft"
            aDraftFileList(1) = "http://solidvm/Engineering/PreReleased/PreReleasedDocLib/CDPlayer/test2.dft"
            aDraftFileStatusList(0) = DocumentStatus.igStatusInReview
            aDraftFileStatusList(1) = DocumentStatus.igStatusInReview
            aRevisionFileList(0) = "http://solidvm/Engineering/PreReleased/PreReleasedDocLib/CDPlayer/test-1.par"
            aRevisionFileList(1) = "http://solidvm/Engineering/PreReleased/PreReleasedDocLib/CDPlayer/test-2.par"
            aRevisionFileStatusList(0) = DocumentStatus.igStatusBaselined
            aRevisionFileStatusList(1) = DocumentStatus.igStatusBaselined

            objInsight.MoveDocumentsThroughWorkFlow(strFileName, DocumentStatus, aDraftFileList.Length, aDraftFileList, aDraftFileStatusList, aRevisionFileList.Length, aRevisionFileList, aRevisionFileStatusList)
        Catch ex As Exception
            ' Write any errors to console.
            Console.WriteLine(ex.Message)
        Finally
            ' Release COM Objects.
            If Not (objInsight Is Nothing) Then
                Marshal.ReleaseComObject(objInsight)
                objInsight = Nothing
            End If

            If Not (objApplication Is Nothing) Then
                objApplication.Quit()
                Marshal.ReleaseComObject(objApplication)
                objApplication = Nothing
            End If
        End Try
    End Sub

End Module