[This is preliminary documentation and is subject to change.]

Gets localized description for given key (or name)

Namespace: Tools.MetadataT
Assembly: Tools.Metadata (in Tools.Metadata.dll) Version: 1.5.3.38916 (1.5.3.38916)

Syntax

C#
string GetDescription(
	string key
)
Visual Basic
Function GetDescription ( _
	key As String _
) As String
Visual C++
String^ GetDescription(
	String^ key
)
F#
abstract GetDescription : 
        key:string -> string
JScript
function GetDescription(
	key : String
) : String

Parameters

key
Type: System..::..String
Key (or name) to get description of

Return Value

Localized description of purpose of metadata item identified by key; nul when description is not available.

Exceptions

ExceptionCondition
System..::..ArgumentExceptionkey is in invalid format or it is not one of predefined names.

See Also

Collapse/expand Version History

1.5.3

  • Parameter Key renamed to key.