Share via


DataServiceContext.BeginLoadProperty Method (Object, String, Uri, AsyncCallback, Object)

Asynchronously loads a page of related entities from the data service by using the supplied next link URI.

Namespace:  System.Data.Services.Client
Assembly:  Microsoft.Data.Services.Client (in Microsoft.Data.Services.Client.dll)

Syntax

'Declaration
Public Function BeginLoadProperty ( _
    entity As Object, _
    propertyName As String, _
    nextLinkUri As Uri, _
    callback As AsyncCallback, _
    state As Object _
) As IAsyncResult
'Usage
Dim instance As DataServiceContext 
Dim entity As Object 
Dim propertyName As String 
Dim nextLinkUri As Uri 
Dim callback As AsyncCallback 
Dim state As Object 
Dim returnValue As IAsyncResult 

returnValue = instance.BeginLoadProperty(entity, _
    propertyName, nextLinkUri, callback, _
    state)
public IAsyncResult BeginLoadProperty(
    Object entity,
    string propertyName,
    Uri nextLinkUri,
    AsyncCallback callback,
    Object state
)
public:
IAsyncResult^ BeginLoadProperty(
    Object^ entity, 
    String^ propertyName, 
    Uri^ nextLinkUri, 
    AsyncCallback^ callback, 
    Object^ state
)
member BeginLoadProperty : 
        entity:Object * 
        propertyName:string * 
        nextLinkUri:Uri * 
        callback:AsyncCallback * 
        state:Object -> IAsyncResult
public function BeginLoadProperty(
    entity : Object, 
    propertyName : String, 
    nextLinkUri : Uri, 
    callback : AsyncCallback, 
    state : Object
) : IAsyncResult

Parameters

  • entity
    Type: System.Object
    The entity that contains the property to load.
  • propertyName
    Type: System.String
    The name of the property of the specified entity to load.
  • nextLinkUri
    Type: System.Uri
    The URI used to load the next results page.
  • callback
    Type: System.AsyncCallback
    Delegate to invoke when results are available for client consumption.
  • state
    Type: System.Object
    User-defined state object passed to the callback.

Return Value

Type: System.IAsyncResult
An IAsyncResult object that is used to track the status of the asynchronous operation.

Remarks

When entity is in an Unchanged or Modified state, the related entities are loaded in the Unchanged state, and the links between the entities are also created in an Unchanged state.

When entity is in a Deleted state, the related entities are loaded in the Unchanged state, and the links between the entities are created in the Deleted state.

See Also

Reference

DataServiceContext Class

BeginLoadProperty Overload

System.Data.Services.Client Namespace