SearchVocabularyKeys Method

SearchVocabularyKeys Method

HealthVault
Searches the keys of vocabularies defined by the HealthVault service.

Namespace: Microsoft.Health
Assembly: Microsoft.Health (in Microsoft.Health.dll) Version: 2.1.0.0 (1.15.1003.9505)

'Declaration
Public Function SearchVocabularyKeys ( _
	searchString As String, _
	searchType As VocabularySearchType, _
	maxResults As Nullable(Of Integer) _
) As ReadOnlyCollection(Of VocabularyKey)

Parameters

searchString
Type: System..::..String
The search string to use.
searchType
Type: Microsoft.Health..::..VocabularySearchType
The type of search to perform.
maxResults
Type: System..::..Nullable<(Of <(<'Int32>)>)>
The maximum number of results to return. If null, all matching results are returned, up to a maximum number defined by the service config value with key maxResultsPerVocabularyRetrieval.

Return Value

A ReadOnlyCollection of VocabularyKey with entries matching the search criteria.

This method does a text search of vocabulary names and descriptions.

ExceptionCondition
System..::..ArgumentException If searchString is null or empty or greater than 255 characters.
-Or-
if searchType is not a known VocabularySearchType value.
-Or-
when maxResults is defined but has a value less than 1.
Microsoft.Health..::..HealthServiceException There is an error in the server request.
Show:
© 2016 Microsoft