DataObjectIdentifierConverter.BuildString Method
Builds a string version of an identifier.
Namespace: Microsoft.VisualStudio.Data
Assembly: Microsoft.VisualStudio.Data (in Microsoft.VisualStudio.Data.dll)
Syntax
'Declaration
Protected Overridable Function BuildString ( _
typeName As String, _
identifierParts As String(), _
forDisplay As Boolean _
) As String
protected virtual string BuildString(
string typeName,
string[] identifierParts,
bool forDisplay
)
protected:
virtual String^ BuildString(
String^ typeName,
array<String^>^ identifierParts,
bool forDisplay
)
abstract BuildString :
typeName:string *
identifierParts:string[] *
forDisplay:bool -> string
override BuildString :
typeName:string *
identifierParts:string[] *
forDisplay:bool -> string
protected function BuildString(
typeName : String,
identifierParts : String[],
forDisplay : boolean
) : String
Parameters
typeName
Type: System.StringThe name of a data object type.
identifierParts
Type: array<System.String[]An array of formatted identifier parts.
forDisplay
Type: System.BooleanIndicates whether the resulting string will be used for display purposes only.
Return Value
Type: System.String
Returns a string version of an identifier.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | The typeName and/or identifierParts parameter is null. |
| ArgumentException | The identifierParts parameter contains invalid data. |
Remarks
When the forDisplay argument is true, the data provider may return an identifier that looks appropriate for a user but is not necessarily a valid identifier on the data source. For example, a two-part identifier "myuser.mytable" may 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.