Click or drag to resize

IExportManagerByName Method

Retrieves an export using its name

Namespace:  EdaIntegrationContract.Exports
Assembly:  EdaIntegration.Contract (in EdaIntegration.Contract.dll) Version: 1.0
Syntax
C#
Copy
IExport ByName(
	string exportName
)

Parameters

exportName
Type: SystemString
The name of the export to retrieve

Return Value

Type: IExport
The export with the supplied unique identifier
Exceptions
ExceptionCondition
EdaApiExceptionThrown if an export cannot be found with the specified name
Examples
The following example demonstrates retrieving an export using its name.
C#
Copy
using EdaIntegrationContract;
using EdaIntegrationContract.Case;
using EdaIntegrationContract.Exports;

class Sample
{
    public static void Main()
    {
        var edaIntegration = new EdaIntegration().ConnectToExplore();
        ICase edaCase = edaIntegration.Cases.OpenCaseByName("Case 1");
        IExport export = edaCase.Exports.ByName("Export-001");
        Console.WriteLine("Name: {0}", export.Name);
        Console.WriteLine("Type: {0}", export.Type);
        Console.WriteLine("Scope: {0}", export.Config.Scope);
        Console.WriteLine("Last Run: {0}", export.LastRun);
        Console.WriteLine("Total Documents: {0}", export.TotalDocuments);
        Console.WriteLine("Error Count: {0}", export.NumErrors);
    }
}
/*
This example produces the following results:

Name: Export-001
Type: Native
Scope: Filtered
Last Run: 7/24/2014 6:30:59 PM
Total Documents: 21049
Error Count: 2
 */
See Also