LibraryManager.Search Method

LibraryManager Search Method

TIBCO Spotfire 6.0 API Reference

Gets a collection of items matching the specified search expression.

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

Syntax

C++

Copy to Clipboard Print

public LibraryItemCollection Search(
	string searchExpression,
	params LibraryItemRetrievalOption[] retrievalOptions
)

public LibraryItemCollection Search(
	string searchExpression,
	params LibraryItemRetrievalOption[] retrievalOptions
)

Parameters

searchExpression: Type: System String
An expression describing the items that shall be returned. The syntax used is the same as in the search field in the "Open from Library" dialog. See the topic "Searching the Library" in the TIBCO Spotfire User´s Guide for a description of the search syntax.

retrievalOptions: Type: Spotfire.Dxp.Framework.Library LibraryItemRetrievalOption
Specifies the kinds of metadata that the returned items shall be populated with.

Return Value

Type: LibraryItemCollection
A collection of items matching the search.

Exceptions

Exception	Condition
Spotfire.Dxp.Framework.Library LibraryException	If an error occurs in the communication with the library.