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.LibraryAssembly: Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 18.10.8513.5432 (18.10.8513.5432)
Syntax
Parameters
- id
- Type: System Guid
The id of the item to get.
- item
- Type: Spotfire.Dxp.Framework.Library LibraryItem
Will be assigned with the library item or null if no item with the specified id 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 id is null. |
System ArgumentException | If id is an empty Guid. |
Version Information
See Also