Export (0) Print
Expand All

ObjectQuery<T>::Include Method

Specifies the related objects to include in the query results.

Namespace:  System.Data.Objects
Assembly:  System.Data.Entity (in System.Data.Entity.dll)

public:
ObjectQuery<T>^ Include(
	String^ path
)

Parameters

path
Type: System::String

Dot-separated list of related objects to return in the query results.

Return Value

Type: System.Data.Objects::ObjectQuery<T>
A new ObjectQuery<T> with the defined query path.

ExceptionCondition
ArgumentNullException

path is nullptr.

ArgumentException

path is empty.

Query paths can be used with Entity SQL and LINQ queries.

Paths are all-inclusive. For example, if an include call indicates Include("Orders.OrderLines"), not only will OrderLines be included, but also Orders. For more information, see Shaping Query Results (Entity Framework).

When you call the Include method, the query path is only valid on the returned instance of the ObjectQuery<T>. Other instances of ObjectQuery<T> and the object context itself are not affected.

Because the Include method returns the query object, you can call this method multiple times on an ObjectQuery<T> to specify multiple paths for the query, as in the following example:

No code example is currently available or this language may not be supported.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5 SP1

.NET Framework Client Profile

Supported in: 4

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft