Class NSExportArchiveResult

Constructors

NSExportArchiveResult()

Initializes a new instance of the NSExportArchiveResult class.

Declaration

NSExportArchiveResult

Methods

GetBatchTaskId()

Declaration

Integer GetBatchTaskId()

Examples

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

Returns

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

GetFileName()

Declaration

String GetFileName()

Examples

NSExportArchiveResult thing;
String fileName = thing.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.

GetMessage()

Declaration

String GetMessage()

Examples

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

Returns

Type Description
String Descriptive messages; errors, etc.

SetBatchTaskId(Integer)

Declaration

Void SetBatchTaskId(Integer batchTaskId)

Examples

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

Parameters

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

Returns

Type Description
Void

SetFileName(String)

Declaration

Void SetFileName(String fileName)

Examples

NSExportArchiveResult thing;
String fileName;
thing.SetFileName(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

SetMessage(String)

Declaration

Void SetMessage(String message)

Examples

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

Parameters

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

Returns

Type Description
Void