Class TokenFindResult

Namespace

ArcanaDevelopment.adTempus.Client

Assembly

ArcanaDevelopment.adTempus.Client.dll

Contains information about Job Variable or Inline Function references found in an object.

public sealed class TokenFindResult

Inheritance

object

TokenFindResult

Fields

Matches

List of TokenFindMatch objects containing the token matches found.

public readonly ReadOnlyCollection<TokenFindMatch> Matches

Field Value

ReadOnlyCollection<TokenFindMatch>

Properties

ObjectDescription

The description of the object in which tokens were found

public string ObjectDescription { get; }

Property Value

string

ObjectOID

The OID of the object in which tokens were found

public OID ObjectOID { get; }

Property Value

OID

Methods

GetPrimaryObject()

Gets the top-level object in which the match was found.

public ADTObject GetPrimaryObject()

Returns

ADTObject

Remarks

If ObjectSearchOptions.ReturnObjects was set to false, the object will be automatically fetched from the server if necessary. If you plan to need the contents of the objects, set ReturnObjects to true so that all objects are returned at once, rather than requiring multiple calls to the server to fetch them individually.

See Also

FindVariablesAndInlineFunctions(TokenSearchOptions, out ReadOnlyCollection<TokenFindResult>, out MessageCollection)