PropertyCollection.GetProperty Method

  • Reference

Definition

Namespace:
Microsoft.CognitiveServices.Speech
Assembly:
Microsoft.CognitiveServices.Speech.csharp.dll
Package:
Microsoft.CognitiveServices.Speech v1.41.1

Overloads

GetProperty(PropertyId)

Searches for the property named with this PropertyId value.
GetProperty(String)

Searches for the property that has this string name.
GetProperty(PropertyId, String)

Searches for the property named with this PropertyId value.
GetProperty(String, String)

Searches for the property that has this string name.

GetProperty(PropertyId)

Searches for the property named with this PropertyId value.

public virtual string GetProperty (Microsoft.CognitiveServices.Speech.PropertyId id);
abstract member GetProperty : Microsoft.CognitiveServices.Speech.PropertyId -> string
override this.GetProperty : Microsoft.CognitiveServices.Speech.PropertyId -> string
Public Overridable Function GetProperty (id As PropertyId) As String

Parameters

id
PropertyId

The ID of property. See PropertyId

Returns

String

value of the property

Remarks

If the property value is not defined, an empty string is returned.

Applies to

GetProperty(String)

Searches for the property that has this string name.

public virtual string GetProperty (string propertyName);
abstract member GetProperty : string -> string
override this.GetProperty : string -> string
Public Overridable Function GetProperty (propertyName As String) As String

Parameters

propertyName
String

The name of property

Returns

String

value of the property

Remarks

If the property value is not defined, an empty string is returned. In most cases, you will use GetProperty(PropertyId) instead of this method.

Applies to

GetProperty(PropertyId, String)

Searches for the property named with this PropertyId value.

public virtual string GetProperty (Microsoft.CognitiveServices.Speech.PropertyId id, string defaultValue);
abstract member GetProperty : Microsoft.CognitiveServices.Speech.PropertyId * string -> string
override this.GetProperty : Microsoft.CognitiveServices.Speech.PropertyId * string -> string
Public Overridable Function GetProperty (id As PropertyId, defaultValue As String) As String

Parameters

id
PropertyId

The id of property. See PropertyId

defaultValue
String

The default value which is returned if no value is defined for the property.

Returns

String

value of the property.

Remarks

If the property value is not defined, the specified default value is returned.

Applies to

GetProperty(String, String)

Searches for the property that has this string name.

public virtual string GetProperty (string propertyName, string defaultValue);
abstract member GetProperty : string * string -> string
override this.GetProperty : string * string -> string
Public Overridable Function GetProperty (propertyName As String, defaultValue As String) As String

Parameters

propertyName
String

The name of property.

defaultValue
String

The default value which is returned if no value is defined for the property.

Returns

String

value of the property.

Remarks

A small number of properties are stored using string names. If the property value is not defined, the specified default value is returned.

Applies to