DataObjectIdentifierResolver.QuickContractIdentifier Method

Article
10/03/2012

Applies an algorithm for quickly contracting an identifier, if possible.

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

Syntax

'Declaration
Protected Overridable Function QuickContractIdentifier ( _
    typeName As String, _
    fullIdentifier As Object() _
) As Object()

protected virtual Object[] QuickContractIdentifier(
    string typeName,
    Object[] fullIdentifier
)

protected:
virtual array<Object^>^ QuickContractIdentifier(
    String^ typeName, 
    array<Object^>^ fullIdentifier
)

abstract QuickContractIdentifier : 
        typeName:string * 
        fullIdentifier:Object[] -> Object[] 
override QuickContractIdentifier : 
        typeName:string * 
        fullIdentifier:Object[] -> Object[]

protected function QuickContractIdentifier(
    typeName : String, 
    fullIdentifier : Object[]
) : Object[]

Parameters

typeName
Type: System.String

The name of a type of data object.

fullIdentifier
Type: array<System.Object[]

A full identifier of a data object.

Return Value

Type: array<System.Object[]
Returns the contracted identifier, or returns nulla null reference (Nothing in Visual Basic) if it was not possible to quickly contract the identifier.

Exceptions

Exception	Condition
ArgumentNullException	The typeName parameter is null.

Remarks

The purpose of this method is to attempt to contract an identifier virtually instantaneous, if possible. For example, this method would not be implemented by making some expensive call to the data source that potentially takes seconds to execute.

The base implementation of the ContractIdentifier method calls this method first to see if there is a quick way to contract the identifier, then proceeds to the SlowContractIdentifier method only when it determines that a quick contraction is not possible.

.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.

Share via