Tries to get the item associated with the specified path. 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: 25.11.10401.3615 (25.11.10401.3615)
Syntax
C#
public bool TryGetItem( string path, LibraryItemType itemType, out LibraryItem item, params LibraryItemRetrievalOption[] retrievalOptions )
Parameters
- path
- Type: SystemString
The path of the item to get. - itemType
- Type: Spotfire.Dxp.Framework.LibraryLibraryItemType
The type of the item. There can be several items with the same path but with different types. - item
- Type: Spotfire.Dxp.Framework.LibraryLibraryItem
Will be assigned with the library item or null if no item with the specified path and type 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: Booleantrue if an item was found, false otherwise.
Exceptions
Exception | Condition |
---|---|
LibraryException | If an error occurs in the communication with the library. |
ArgumentNullException | If path or itemType is null. |
ArgumentException | If path is an empty string. |
Version Information
See Also