> ## 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.

# NSReturnInfo

> Return value object for Document Plugin API calls.

Return value object for Document Plugin API calls.

## Constructors

### NSReturnInfo()

```crmscript theme={null}
NSReturnInfo
```

Initializes a new instance of the NSReturnInfo class.

## Methods

## GetAdditionalInfo()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Optional, additional information meant for further processing.

<Note>
  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.
</Note>

**Example:**

```crmscript theme={null}
NSReturnInfo thing;
String additionalInfo = thing.GetAdditionalInfo();
```

## GetExternalReference()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The document plugin's key that uniquely identifies a document.

<Note>
  Stored in the externalReference field of the document table
</Note>

**Example:**

```crmscript theme={null}
NSReturnInfo thing;
String externalReference = thing.GetExternalReference();
```

## GetSuccess()

```crmscript theme={null}
Bool GetSuccess()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Did the call succeed. A successful call may still return a message or other return value.

**Example:**

```crmscript theme={null}
NSReturnInfo thing;
Bool success = thing.GetSuccess();
```

## GetType()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - How is the return value to be understood by the caller. See \<xref href="CRMScript.NetServer.ReturnType" data-throw-if-not-resolved="false">\</xref>.

**Example:**

```crmscript theme={null}
NSReturnInfo thing;
Integer type = thing.GetType();
```

## GetValue()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Return value, may be blank.

**Example:**

```crmscript theme={null}
NSReturnInfo thing;
String value = thing.GetValue();
```

## GetVersionId()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The document plugin's version id that uniquely identifies one version of a document.

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

**Example:**

```crmscript theme={null}
NSReturnInfo thing;
String versionId = thing.GetVersionId();
```

## SetAdditionalInfo(String)

```crmscript theme={null}
Void SetAdditionalInfo(String additionalInfo)
```

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

<Note>
  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.
</Note>

**Example:**

```crmscript theme={null}
NSReturnInfo thing;
String additionalInfo;
thing.SetAdditionalInfo(additionalInfo);
```

## SetExternalReference(String)

```crmscript theme={null}
Void SetExternalReference(String externalReference)
```

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

<Note>
  Stored in the externalReference field of the document table
</Note>

**Example:**

```crmscript theme={null}
NSReturnInfo thing;
String externalReference;
thing.SetExternalReference(externalReference);
```

## SetSuccess(Bool)

```crmscript theme={null}
Void SetSuccess(Bool success)
```

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

**Example:**

```crmscript theme={null}
NSReturnInfo thing;
Bool success;
thing.SetSuccess(success);
```

## SetType(Integer)

```crmscript theme={null}
Void SetType(Integer type)
```

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

**Example:**

```crmscript theme={null}
NSReturnInfo thing;
Integer type;
thing.SetType(type);
```

## SetValue(String)

```crmscript theme={null}
Void SetValue(String value)
```

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

**Example:**

```crmscript theme={null}
NSReturnInfo thing;
String value;
thing.SetValue(value);
```

## SetVersionId(String)

```crmscript theme={null}
Void SetVersionId(String versionId)
```

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

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

**Example:**

```crmscript theme={null}
NSReturnInfo thing;
String versionId;
thing.SetVersionId(versionId);
```


## Related topics

- [NSDocumentAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSDocumentAgent.md)
- [Document files](/en/automation/crmscript/howto/document/file.md)
- [NSCommandInfo](/en/automation/crmscript/reference/CRMScript.NetServer.NSCommandInfo.md)
- [Request For Info](/en/api/reference/restful/agent/appointment_agent/request-for-info.md)
- [NSLicenseInfo](/en/automation/crmscript/reference/CRMScript.NetServer.NSLicenseInfo.md)
- [NSUserInfo](/en/automation/crmscript/reference/CRMScript.NetServer.NSUserInfo.md)