Class NSExportArchiveResult

Syntax

Constructors

NSExportArchiveResult()

Initializes a new instance of the NSExportArchiveResult class.

Declaration

NSExportArchiveResult

Methods

GetBatchTaskId()

Declaration

Integer GetBatchTaskId()

Returns

Type	Description
Integer	ID of the BatchTask created. <=0 if no BatchTask was created.

Examples

NSExportArchiveResult thing;
Integer batchTaskId = thing.GetBatchTaskId();

GetFileName()

Declaration

String GetFileName()

Returns

Type	Description
String	The path to the output file created, if it exists. Will be an empty string if no file was created.

Examples

NSExportArchiveResult thing;
String fileName = thing.GetFileName();

GetMessage()

Declaration

String GetMessage()

Returns

Type	Description
String	Descriptive messages; errors, etc.

Examples

NSExportArchiveResult thing;
String message = thing.GetMessage();

SetBatchTaskId(Integer)

Declaration

Void SetBatchTaskId(Integer batchTaskId)

Parameters

Type	Name	Description
Integer	batchTaskId	ID of the BatchTask created. <=0 if no BatchTask was created.

Returns

Type	Description
Void

Examples

NSExportArchiveResult thing;
Integer batchTaskId;
thing.SetBatchTaskId(batchTaskId);

SetFileName(String)

Declaration

Void SetFileName(String fileName)

Parameters

Type	Name	Description
String	fileName	The path to the output file created, if it exists. Will be an empty string if no file was created.

Returns

Type	Description
Void

Examples

NSExportArchiveResult thing;
String fileName;
thing.SetFileName(fileName);

SetMessage(String)

Declaration

Void SetMessage(String message)

Parameters

Type	Name	Description
String	message	Descriptive messages; errors, etc.

Returns

Type	Description
Void

Examples

NSExportArchiveResult thing;
String message;
thing.SetMessage(message);