AdoDotNetObjectIdentifierConverter.BuildString Method

Concatenates identifier parts into a string and inserts the separator character in between.

Namespace:  Microsoft.VisualStudio.Data.Framework.AdoDotNet
Assembly:  Microsoft.VisualStudio.Data.Framework (in Microsoft.VisualStudio.Data.Framework.dll)

Syntax

'Declaration
Protected Overrides Function BuildString ( _
    typeName As String, _
    identifierParts As String(), _
    format As DataObjectIdentifierFormat _
) As String

protected override string BuildString(
    string typeName,
    string[] identifierParts,
    DataObjectIdentifierFormat format
)

protected:
virtual String^ BuildString(
    String^ typeName, 
    array<String^>^ identifierParts, 
    DataObjectIdentifierFormat format
) override

abstract BuildString : 
        typeName:string * 
        identifierParts:string[] * 
        format:DataObjectIdentifierFormat -> string  
override BuildString : 
        typeName:string * 
        identifierParts:string[] * 
        format:DataObjectIdentifierFormat -> string

protected override function BuildString(
    typeName : String, 
    identifierParts : String[], 
    format : DataObjectIdentifierFormat
) : String

Parameters

• typeName
  Type: System.String

  The type of the database object.

• identifierParts
  Type: array<System.String[]

  An array of formatted identifier parts.

• format
  Type: Microsoft.VisualStudio.Data.Services.DataObjectIdentifierFormat

  A value of the DataObjectIdentifierFormat enumeration. This value is used to check whether the string is used for display purposes only. If so, the format of the string is changed.

Return Value

Type: System.String
The concatenated string containing all identifiers in the given order.

Remarks

When the format argument equals DataObjectIdentifierFormat.ForDisplay, the data provider might return an identifier that looks appropriate for a user but is not necessarily a valid identifier on the data source. For example, the two-part identifier "myuser.mytable" might be valid on the data source, but a suitable display version might be "mytable (User: myuser)".

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

AdoDotNetObjectIdentifierConverter Class

Microsoft.VisualStudio.Data.Framework.AdoDotNet Namespace