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.LibraryAssembly: Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 18.10.8513.5432 (18.10.8513.5432)
Syntax
Parameters
- path
- Type: System String
The path of the item to get.
- itemType
- Type: Spotfire.Dxp.Framework.Library LibraryItemType
The type of the item. There can be several items with the same path but with different types.
- item
- Type: Spotfire.Dxp.Framework.Library LibraryItem
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.Library LibraryItemRetrievalOption
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 |
---|---|
Spotfire.Dxp.Framework.Library LibraryException | If an error occurs in the communication with the library. |
System ArgumentNullException | If path or itemType is null. |
System ArgumentException | If path is an empty string. |
Version Information
See Also