> Get External References Example (C#)
Welcome
Getting Started
SolidWorks API Help
FeatureWorks API Help
SolidWorks Document Manager API Help
eDrawings API Help
SolidWorks Routing API Help
SolidWorks Simulation API Help
SolidWorks Utilities API Help
SolidWorks Workgroup PDM API Help
Hide Table of Contents Show Table of Contents

Get External References Example (C#)

This example shows how to get all of the external references for the base part using the SolidWorks Document Manager API.

//----------------------------------------------------------------------------
// Preconditions:
// 1. Read the SolidWorks Document Manager API
//    Getting Started topic and ensure that the
//    required DLLs have been registered.
// 2. Copy and paste this code into a C# console application
//    in Microsoft Visual Studio.
// 3. Modify the path of the specified assembly.
// 4. Rename the namespace to match the name of your C# project.
// 5. Add the SolidWorks.Interop.swdocumentmgr.dll
//    reference to the project:
//    a. Right-click the solution in Solution Explorer.
//    b. Select Add Reference.
//    c. Click Browse.
//    d. Select:
//    <SolidWorks_install_dir>\api\redist\SolidWorks.Interop.swdocumentmgr.dll
// 6. Substitute your_license_code with your
//    SolidWorks Document Manager license key.
// 7. Ensure that c:\temp exists.
//
// Postconditions:
// 1. Inspect the Immediate Window for the external references and their
//    configurations.
// 2. Inspect c:\temp\extRef.xml for more information about the external
//    references.
//--------------------------------------------------------------------------
 

using System;
using System.Collections.Generic;
using System.Text;
using System.Diagnostics;
using SolidWorks.Interop.swdocumentmgr;

namespace GetExtRef_CSharp
{
    class Program
    {

        static SwDMClassFactory dmClassFact;
        static SwDMApplication3 dmDocMgr;
        static SwDMDocument15 dmDoc;
        static SwDmDocumentType dmDocType;
        static SwDMSearchOption dmSearchOpt;
        static SwDmDocumentOpenError status;
        static SwDMExternalReferenceOption dmExtRefOption;
        static int numExtRefs;

        static SwDmXmlDataError xmlError;

        const string docPath = "<SolidWorks_install_dir>\\samples\\tutorial\api\\assembly-with-mirrored-component.sldasm";
        const string licenseKey = "your_license_code";
        
        static void Main()
        {
            
            setDocType();

            dmClassFact = new SwDMClassFactory();
            dmDocMgr = (SwDMApplication3)dmClassFact.GetApplication(licenseKey);
            dmDoc = (SwDMDocument15)dmDocMgr.GetDocument(docPath, dmDocType, true, out status);

            if ((dmDoc != null))
            {
                NewMethod();

                dmDoc.GetXmlStream("c:\\temp\\extRef.xml", ref xmlError);
                dmDoc.CloseDoc();
            }
            else
            {
                Debug.Print("Unable to open document. Check 'docPath' variable path.");
            }

        }


        public static void NewMethod()
        {
            dmExtRefOption = dmDocMgr.GetExternalReferenceOptionObject();
            dmSearchOpt = dmDocMgr.GetSearchOptionObject();

            dmExtRefOption.SearchOption = dmSearchOpt;

            dmExtRefOption.Configuration = "Default";

            dmExtRefOption.NeedSuppress = true;
            numExtRefs = dmDoc.GetExternalFeatureReferences(ref dmExtRefOption);

            PrintStrings("FilePath", dmExtRefOption.ExternalReferences);
            PrintStrings("ConfigName", dmExtRefOption.ReferencedConfigurations);

            dmSearchOpt = null;
            dmExtRefOption = null;

        }

        public static void setDocType()
        {
            string typeStr = null;

            typeStr = docPath.Substring((docPath.Length - 6),6);
            typeStr = typeStr.ToUpper();

            if ((typeStr == "SLDPRT"))
            {
                dmDocType = SwDmDocumentType.swDmDocumentPart;
            }
            else if ((typeStr == "SLDASM"))
            {
                dmDocType = SwDmDocumentType.swDmDocumentAssembly;
            }

        }


        public static void PrintStrings(string name, object varInp)
        {
            int I = 0;
            String[] arrInp;
            arrInp = (String[])varInp;
            for (I = 0; I < arrInp.Length; I++)
            {
                string str = null;
                str = arrInp[I];
                Debug.Print(name + " : " + str);
            }

        }

    }
}



Related SolidWorks Forum Content

Provide feedback on this topic

SolidWorks welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   Get External References Example (C#)
*Comment:  
x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2012 SP05

The search functionality within the web help is in a beta test phase and you may experience periodic delays or interruptions in its performance. These are the normal and ordinary features of a beta test and shall not under any circumstances give rise to any liability on the part of DS SolidWorks or its licensors. The topics within the Web-based help are not beta topics; they document API Help (English only) 2012 SP05.

To disable Web help from within SolidWorks and use local help instead, click Help > Use SolidWorks Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.