LibraryManagerTryGetItem Method (Guid, LibraryItem, LibraryItemRetrievalOption)

Spotfire 14.3 API Reference

Tries to get the item associated with the specified id. Returns true if the item is found and false otherwise. On success, the item parameter is assigned and populated according to the specified metadata options.

Namespace: Spotfire.Dxp.Framework.Library
Assembly: Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 65.0.19510.3242 (65.0.19510.3242)

Syntax

Copy

public bool TryGetItem(
	Guid id,
	out LibraryItem item,
	params LibraryItemRetrievalOption[] retrievalOptions
)

Parameters

id: Type: SystemGuid
The id of the item to get.
item: Type: Spotfire.Dxp.Framework.LibraryLibraryItem
Will be assigned with the library item or null if no item with the specified id can be found.
retrievalOptions: Type: Spotfire.Dxp.Framework.LibraryLibraryItemRetrievalOption
Specifies the kinds of metadata that the returned item shall be populated with.

Return Value

Type: Boolean
true if an item was found, false otherwise.

Exceptions

Exception	Condition
LibraryException	If an error occurs in the communication with the library.
ArgumentNullException	If id is null.
ArgumentException	If id is an empty Guid.

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

Reference

LibraryManager Class

TryGetItem Overload

Spotfire.Dxp.Framework.Library Namespace