TaskExecutionContextLibraryPathToId Method

Spotfire Automation Services 14.3 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: 65.0.19510.3242 (65.0.19510.3242)
Syntax

C#
public virtual string LibraryPathToId(
	AnalysisApplication application,
	string path
)

Parameters

application
Type: AnalysisApplication
The application object to use to perform the look-up.
path
Type: SystemString
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

ExceptionCondition
ArgumentExceptionapplication 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

Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also

Reference