SetReviseSelected Method

Description

This API is used to set revise action on a selected file in the structure editor.

Syntax

Visual Basic
Public Function SetReviseSelected( _ ByVal bstrItemId As String, _ ByVal bstrItemRev As String, _ ByVal bstrDataSetFileName As String, _ Optional ByVal szPrntItemId As String, _ Optional ByVal szPrntItemRev As String, _ Optional ByVal szPrntDataSetFileName As String _ ) As Long

Visual Basic

Public Function SetReviseSelected( _
   ByVal bstrItemId As String, _
   ByVal bstrItemRev As String, _
   ByVal bstrDataSetFileName As String, _
   Optional ByVal szPrntItemId As String, _
   Optional ByVal szPrntItemRev As String, _
   Optional ByVal szPrntDataSetFileName As String _
) As Long

Parameters

bstrItemId: Specifies the item id of the document on which the save as action is to be set.
bstrItemRev: Specifies the revision of the document on which the save as action is to be set.
bstrDataSetFileName: Specifies the Name of the file on which the save as action is to be set.
szPrntItemId
szPrntItemRev
szPrntDataSetFileName

Remarks

Call this method after calling Open() method. Because for calling this API a solid edge file needs to be opened in the structure editor application. If the action is set without opening a solid edge file in the application then nothing will happen. If user wants to select multiple files for save as then the above code needs to be called multiple times.

Example

Example (VB.NET)

Imports System.IO
Imports System.Runtime.InteropServices

Module Example
    <STAThread()> _
    Sub Main()
        Dim objApplication As StructureEditor.Application = Nothing
        Dim objStructureEditor As StructureEditor.SEECStructureEditor = Nothing
        Dim strItemId As String
        Dim strItemRev As String
        Dim strFileName As String
        Dim strRevisionRule As String
        Dim strFolderName As String

        Try
            OleMessageFilter.Register()

            ' Start structure editor application
            objApplication = Activator.CreateInstance(Type.GetTypeFromProgID("StructureEditor.Application"))
            objStructureEditor = objApplication.SEECStructureEditor
            objApplication.Visible = True

            strItemId = "081691"
            strItemRev = "A"
            strFileName = "a.asm"
            strRevisionRule = "Latest Working"
            strFolderName = ""

            If objStructureEditor.Open(strItemId, strItemRev, strFileName, strRevisionRule, strFolderName) = 0 Then
                objStructureEditor.SetReviseSelected(strItemId, strItemRev, strFileName)
            End If
        Catch ex As Exception
            Console.WriteLine(ex.Message)
        Finally
            If Not objApplication Is Nothing Then
                ' Kill the instance of structure editor created
                objApplication.Quit()
            End If

            OleMessageFilter.Revoke()
        End Try
    End Sub
End Module