IVsDataObjectIdentifierConverter Interface

Represents the interface that exposes methods for converting data source–specific object identifiers from strings to identifier parts, and from identifier parts to strings.

Namespace:  Microsoft.VisualStudio.Data.Services.SupportEntities
Assembly:  Microsoft.VisualStudio.Data.Services (in Microsoft.VisualStudio.Data.Services.dll)

Syntax

'Declaration
<DataClientObjectAttribute("25F7A929-9E69-4e2f-8B31-93661DB50853")> _
Public Interface IVsDataObjectIdentifierConverter

[DataClientObjectAttribute("25F7A929-9E69-4e2f-8B31-93661DB50853")]
public interface IVsDataObjectIdentifierConverter

[DataClientObjectAttribute(L"25F7A929-9E69-4e2f-8B31-93661DB50853")]
public interface class IVsDataObjectIdentifierConverter

[<DataClientObjectAttribute("25F7A929-9E69-4e2f-8B31-93661DB50853")>]
type IVsDataObjectIdentifierConverter =  interface end

public interface IVsDataObjectIdentifierConverter

The IVsDataObjectIdentifierConverter type exposes the following members.

Methods

	Name	Description
	ConvertToArray	When implemented by a class, converts a formatted string identifier into its equivalent set of identifier parts.
	ConvertToString(String, array<Object[])	When implemented by a class, converts a set of identifier parts into a formatted string identifier.
	ConvertToString(String, array<Object[], DataObjectIdentifierFormat)	When implemented by a class, converts a set of identifier parts into a formatted string identifier, based on the specified formatting option.

Top

Remarks

Typically, the identifier of an object in a data source consists of a string that is used in commands that get executed. For example, in the SQL statement SELECT * FROM mytable, the string "mytable" is the unique identifier of an object in the context under which the statement is running.

Typically, a data source has some kind of containment mechanism for objects, such as a catalog, schema, or package. This introduces the need for multi-part identifiers because a single name no longer suffices for uniquely identifying objects. For example, an Oracle server groups different objects under different users, causing the unique identifier of an object to be qualified with a user name.

Because the format of such multi-part identifiers can vary from one data source to another, there has to be a way to convert a given string into its set of parts and vice versa. This class provides such a mechanism.

This interface has a base implementation in the DDEX Framework.

See Also

Reference

Microsoft.VisualStudio.Data.Services.SupportEntities Namespace