Share via

EntityInstanceIdEncoder.DecodeEntityInstanceId Method

  • Article

Decodes entity instance identifiers.

Namespace:  Microsoft.Office.Server.ApplicationRegistry.Infrastructure
Assembly:  Microsoft.SharePoint.Portal (in Microsoft.SharePoint.Portal.dll)

Syntax

'Declaration
Public Shared Function DecodeEntityInstanceId ( _
    encodedId As String _
) As Object()

'Usage
Dim encodedId As String
Dim returnValue As Object()

returnValue = EntityInstanceIdEncoder.DecodeEntityInstanceId(encodedId)

public static Object[] DecodeEntityInstanceId(
    string encodedId
)

Parameters

Return Value

Type: []
An array of identifier values.

Remarks

When entity instances are transformed into data rows in a data table, they lose the special semantics attached to them in the Business Data Catalog, such as the ability to call instance methods on them. Serializing the ID column enables you to call instance methods. When the Business Data Catalog serializes the ID column, it encodes it, so you must decode the ID column before you can use the ID values. To decode the identifier column, use the EntityInstanceIdEncoder.DecodeEntityInstanceId() method and pass in ColNameSerializedId, which is the name the Business Data Catalog assigns to the serialized ID column. This decodes the identifiers and returns an array of identifier values.

See Also

Reference

EntityInstanceIdEncoder Class

EntityInstanceIdEncoder Members

Microsoft.Office.Server.ApplicationRegistry.Infrastructure Namespace