> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# NSExportArchiveResult

## Constructors

### NSExportArchiveResult()

```crmscript theme={null}
NSExportArchiveResult
```

Initializes a new instance of the NSExportArchiveResult class.

## Methods

## GetBatchTaskId()

```crmscript theme={null}
Integer GetBatchTaskId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - ID of the BatchTask created. \<=0 if no BatchTask was created.

**Example:**

```crmscript theme={null}
NSExportArchiveResult thing;
Integer batchTaskId = thing.GetBatchTaskId();
```

## GetFileName()

```crmscript theme={null}
String GetFileName()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The path to the output file created, if it exists. Will be an empty string if no file was created.

**Example:**

```crmscript theme={null}
NSExportArchiveResult thing;
String fileName = thing.GetFileName();
```

## GetMessage()

```crmscript theme={null}
String GetMessage()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Descriptive messages; errors, etc.

**Example:**

```crmscript theme={null}
NSExportArchiveResult thing;
String message = thing.GetMessage();
```

## SetBatchTaskId(Integer)

```crmscript theme={null}
Void SetBatchTaskId(Integer batchTaskId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSExportArchiveResult thing;
Integer batchTaskId;
thing.SetBatchTaskId(batchTaskId);
```

## SetFileName(String)

```crmscript theme={null}
Void SetFileName(String fileName)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSExportArchiveResult thing;
String fileName;
thing.SetFileName(fileName);
```

## SetMessage(String)

```crmscript theme={null}
Void SetMessage(String message)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSExportArchiveResult thing;
String message;
thing.SetMessage(message);
```


## Related topics

- [NSArchiveAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSArchiveAgent.md)
- [SuperOffice.WebApi.Data.ExportArchiveResult](/en/api/reference/webapi/SuperOffice.WebApi.Data.ExportArchiveResult.md)
- [Export Archive](/en/api/reference/restful/agent/archive_agent/export-archive.md)
- [Export section tabs](/en/learn/section-tabs/export-archives.md)
- [SuperOffice.WebApi.Agents.ArchiveAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ArchiveAgent.md)
- [SuperOffice.WebApi.Agents.IArchiveAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IArchiveAgent.md)
