IsDocumentFOP Method

Description

Given a file, this method determines whether it is an FOP or not. If yes, whether it is an FOP master or a member.

Syntax

Visual Basic
Public Function IsDocumentFOP( _ ByRef FOPStatus As Long _ ) As Long

Parameters

FOPStatus

Member	Value
FOPMasterAndChild	6
FOPMasterDocument	2
FOPMemberDocument	4
FopStatusUnknown	0
NotInvolvedInFOP	1

Example

Example (VB.NET)

Imports RevisionManager
Imports System.Runtime.InteropServices

Module Example

    Sub Main()
        Dim objApplication As RevisionManager.Application = Nothing
        Dim objDocument As RevisionManager.Document = Nothing
        Dim iFOPStatus As Integer
        Dim iRetVal As Integer

        Try
            ' Start Revision Manager.
            objApplication = New RevisionManager.Application
            objDocument = objApplication.Open("C:\Part1.par")
            iRetVal = objDocument.IsDocumentFOP(iFOPStatus)
        Catch ex As Exception
            ' Write any errors to console.
            Console.WriteLine(ex.Message)
        Finally
            ' Release COM Objects.
            If Not (objDocument Is Nothing) Then
                Marshal.ReleaseComObject(objDocument)
                objDocument = Nothing
            End If
            If Not (objApplication Is Nothing) Then
                objApplication.Quit()
                Marshal.ReleaseComObject(objApplication)
                objApplication = Nothing
            End If
        End Try
    End Sub

End Module