Class NSReturnInfo

Return value object for Document Plugin API calls.

Syntax

Constructors

NSReturnInfo()

Initializes a new instance of the NSReturnInfo class.

Introduced or updated in version: 7

Declaration

NSReturnInfo

Methods

GetAdditionalInfo()

Introduced or updated in version: 7

Declaration

String GetAdditionalInfo()

Returns

Type	Description
String	Optional, additional information meant for further processing.

Remarks

This member is ignored for return types None, Message and SoProtocol. It can be used to pass execution-dependent information to the code that handles CustomGui and Other.

Examples

NSReturnInfo thing;
String additionalInfo = thing.GetAdditionalInfo();

GetExternalReference()

Introduced or updated in version: 7

Declaration

String GetExternalReference()

Returns

Type	Description
String	The document plugin's key that uniquely identifies a document.

Remarks

Stored in the externalReference field of the document table

Examples

NSReturnInfo thing;
String externalReference = thing.GetExternalReference();

GetSuccess()

Introduced or updated in version: 7

Declaration

Bool GetSuccess()

Returns

Type	Description
Bool	Did the call succeed. A successful call may still return a message or other return value.

Examples

NSReturnInfo thing;
Bool success = thing.GetSuccess();

GetType()

Introduced or updated in version: 7

Declaration

Integer GetType()

Returns

Type	Description
Integer	How is the return value to be understood by the caller. See ReturnType.

Examples

NSReturnInfo thing;
Integer type = thing.GetType();

GetValue()

Introduced or updated in version: 7

Declaration

String GetValue()

Returns

Type	Description
String	Return value, may be blank.

Examples

NSReturnInfo thing;
String value = thing.GetValue();

GetVersionId()

Introduced or updated in version: 7

Declaration

String GetVersionId()

Returns

Type	Description
String	The document plugin's version id that uniquely identifies one version of a document.

Remarks

If versioning is not supported, this will be blank. When versioning is supported, blank values imply the latest checked-in version.

Examples

NSReturnInfo thing;
String versionId = thing.GetVersionId();

SetAdditionalInfo(String)

Introduced or updated in version: 7

Declaration

Void SetAdditionalInfo(String additionalInfo)

Parameters

Type	Name	Description
String	additionalInfo	Optional, additional information meant for further processing.

Returns

Type	Description
Void

Remarks

This member is ignored for return types None, Message and SoProtocol. It can be used to pass execution-dependent information to the code that handles CustomGui and Other.

Examples

NSReturnInfo thing;
String additionalInfo;
thing.SetAdditionalInfo(additionalInfo);

SetExternalReference(String)

Introduced or updated in version: 7

Declaration

Void SetExternalReference(String externalReference)

Parameters

Type	Name	Description
String	externalReference	The document plugin's key that uniquely identifies a document.

Returns

Type	Description
Void

Remarks

Stored in the externalReference field of the document table

Examples

NSReturnInfo thing;
String externalReference;
thing.SetExternalReference(externalReference);

SetSuccess(Bool)

Introduced or updated in version: 7

Declaration

Void SetSuccess(Bool success)

Parameters

Type	Name	Description
Bool	success	Did the call succeed. A successful call may still return a message or other return value.

Returns

Type	Description
Void

Examples

NSReturnInfo thing;
Bool success;
thing.SetSuccess(success);

SetType(Integer)

Introduced or updated in version: 7

Declaration

Void SetType(Integer type)

Parameters

Type	Name	Description
Integer	type	How is the return value to be understood by the caller See ReturnType.

Examples

NSReturnInfo thing;
Integer type;
thing.SetType(type);

SetValue(String)

Introduced or updated in version: 7

Declaration

Void SetValue(String value)

Parameters

Type	Name	Description
String	value	Return value, may be blank.

Returns

Type	Description
Void

Examples

NSReturnInfo thing;
String value;
thing.SetValue(value);

SetVersionId(String)

Introduced or updated in version: 7

Declaration

Void SetVersionId(String versionId)

Parameters

Type	Name	Description
String	versionId	The document plugin's version id that uniquely identifies one version of a document.

Returns

Type	Description
Void

Remarks

If versioning is not supported, this will be blank. When versioning is supported, blank values imply the latest checked-in version.

Examples

NSReturnInfo thing;
String versionId;
thing.SetVersionId(versionId);