MetadataDisplayInfoProvider.GetDescription Method

Gets the description of the specified IMetadataObject object.

Namespace:  Microsoft.SqlServer.Management.SqlParser.MetadataProvider
Assembly:  Microsoft.SqlServer.Management.SqlParser (in Microsoft.SqlServer.Management.SqlParser.dll)

Syntax

'Declaration
Public Function GetDescription ( _
    metadataObject As IMetadataObject _
) As String
'Usage
Dim instance As MetadataDisplayInfoProvider 
Dim metadataObject As IMetadataObject 
Dim returnValue As String 

returnValue = instance.GetDescription(metadataObject)

public string GetDescription(
    IMetadataObject metadataObject
)

public:
virtual String^ GetDescription(
    IMetadataObject^ metadataObject
) sealed

abstract GetDescription : 
        metadataObject:IMetadataObject -> string  
override GetDescription : 
        metadataObject:IMetadataObject -> string

public final function GetDescription(
    metadataObject : IMetadataObject
) : String

Parameters

• metadataObject
  Type: Microsoft.SqlServer.Management.SqlParser.Metadata.IMetadataObject
  The metadata object to get the description of.

Return Value

Type: System.String
The description of the metadata object.

Implements

IMetadataDisplayInfoProvider.GetDescription(IMetadataObject)

See Also

Reference

MetadataDisplayInfoProvider Class

Microsoft.SqlServer.Management.SqlParser.MetadataProvider Namespace