IAttributeStore.BeginExecuteQuery Method (String, String[], AsyncCallback, Object)

 

Called by the Active Directory® Federation Services (AD FS) 2.0 policy engine to start a query request on the attribute store.

Namespace:   Microsoft.IdentityServer.ClaimsPolicy.Engine.AttributeStore
Assembly:  Microsoft.IdentityServer.ClaimsPolicy (in Microsoft.IdentityServer.ClaimsPolicy.dll)

Syntax

IAsyncResult BeginExecuteQuery(
    string query,
    string[] parameters,
    AsyncCallback callback,
    object state
)

IAsyncResult^ BeginExecuteQuery(
    String^ query,
    array<String^>^ parameters,
    AsyncCallback^ callback,
    Object^ state
)

abstract BeginExecuteQuery : 
        query:string *
        parameters:string[] *
        callback:AsyncCallback *
        state:Object -> IAsyncResult

Function BeginExecuteQuery (
    query As String,
    parameters As String(),
    callback As AsyncCallback,
    state As Object
) As IAsyncResult

Parameters

• query
  Type: System.String

  A string that contains the query to be executed.

• parameters
  Type: System.String[]

  An array of strings that contains parameters for the query.

• callback
  Type: System.AsyncCallback

  The AsyncCallback delegate. A reference to the callback method that the attribute store should invoke at the end of the query.

• state
  Type: System.Object

  An object that contains state information for the query.

Return Value

Type: System.IAsyncResult

An IAsyncResult object that represents the asynchronous query. This will be passed to the EndExecuteQuery method by the policy engine..

Remarks

The policy engine calls the BeginExecuteQuery method to start a query request on the attribute store. The attribute store should invoke the callback method referenced in the callback parameter when the query is complete. The object passed in the state parameter is made available in the P:Microsoft.IdentityModel.Threading.AsyncResult.AsyncState property of the IAsyncResult reference returned by this method. The IAsyncResult reference that is returned by this method is passed as the result parameter of the EndExecuteQuery method when it is invoked by the policy engine.

For a detailed overview of AD FS 2.0 attribute stores, as well as information, including code samples, about how to implement custom attribute stores, see AD FS 2.0 Attribute Store Overview.For more detailed information about AD FS 2.0 attribute stores and for information, including code samples, about how to create a custom attribute store, see AD FS 2.0 Attribute Store Overview.

See Also

IAttributeStore Interface
Microsoft.IdentityServer.ClaimsPolicy.Engine.AttributeStore Namespace

Return to top