TaskExecutionContext.LibraryPathToId Method

TaskExecutionContext LibraryPathToId Method

TIBCO Spotfire Automation Services 7.0 API Reference

Finds the id of the Library analysis entry with the given path.

Namespace: Spotfire.Dxp.Automation.Extension
Assembly: Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll) Version: 18.10.8513.5432 (18.10.8513.5432)

Syntax

C++

Copy to Clipboard Print

public virtual string LibraryPathToId(
	AnalysisApplication application,
	string path
)

public virtual string LibraryPathToId(
	AnalysisApplication application,
	string path
)

Parameters

application: Type: AnalysisApplication
The application object to use to perform the look-up.

path: Type: System String
The path for which the id will be found.

Return Value

Type:

String
The id of the Library entry at the path given by path.

Exceptions

Exception	Condition
System ArgumentException	application is null or path is null or empty.
LibraryException	performed when the application is run in offline mode, a communication error occurs while performing the look-up, e.g. the Library cannot be accessed, the entry does not exist or is of an invalid type.

Version Information