AbstractEntityInstance.GetAssociatedInstances Method (String)

When overridden in a derived class, gets the associated entity instances for this entity instance for the association specified by the name.

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

Syntax

'Declaration
Public Overridable Function GetAssociatedInstances ( _
    associationName As String _
) As IEntityInstanceEnumerator

'Usage
Dim instance As AbstractEntityInstance
Dim associationName As String
Dim returnValue As IEntityInstanceEnumerator

returnValue = instance.GetAssociatedInstances(associationName)

public virtual IEntityInstanceEnumerator GetAssociatedInstances(
    string associationName
)

Parameters

• associationName
  Type: System.String
  A valid Association name for this entity.

Return Value

Type: Microsoft.Office.Server.ApplicationRegistry.Runtime.IEntityInstanceEnumerator
An IEntityInstanceEnumerator containing the related entity instances for this entity instance.

Implements

IEntityInstance.GetAssociatedInstances(String)

Remarks

All Business Data Catalog associations are 1 to many. Therefore, what comes back is always a stream of 0 or more entity instances.

See Also

Reference

AbstractEntityInstance Class

AbstractEntityInstance Members

GetAssociatedInstances Overload

Microsoft.Office.Server.ApplicationRegistry.Runtime Namespace