CrmServiceClient.GetEntityDataByFetchSearch Method (String, Int32, Int32, String, String, Boolean, Guid)

 

Applies To: Dynamics CRM 2015

Searches for data based on a FetchXML query

Namespace:   Microsoft.Xrm.Tooling.Connector
Assembly:  Microsoft.Xrm.Tooling.Connector (in Microsoft.Xrm.Tooling.Connector.dll)

Syntax

public Dictionary<string, Dictionary<string, object>> GetEntityDataByFetchSearch(
    string fetchXml,
    int pageCount,
    int pageNumber,
    string pageCookie,
    out string outPageCookie,
    out bool isMoreRecords,
    Guid batchId = null
)

public:
Dictionary<String^, Dictionary<String^, Object^>^>^ GetEntityDataByFetchSearch(
    String^ fetchXml,
    int pageCount,
    int pageNumber,
    String^ pageCookie,
    [OutAttribute] String^% outPageCookie,
    [OutAttribute] bool% isMoreRecords,
    Guid batchId = null
)

member GetEntityDataByFetchSearch : 
        fetchXml:string *
        pageCount:int *
        pageNumber:int *
        pageCookie:string *
        outPageCookie:string byref *
        isMoreRecords:bool byref *
        batchId:Guid = null -> Dictionary<string, Dictionary<string, Object>>

Public Function GetEntityDataByFetchSearch (
    fetchXml As String,
    pageCount As Integer,
    pageNumber As Integer,
    pageCookie As String,
    <OutAttribute> ByRef outPageCookie As String,
    <OutAttribute> ByRef isMoreRecords As Boolean,
    batchId As Guid
) As Dictionary(Of String, Dictionary(Of String, Object))

Parameters

• fetchXml
  Type: System.String

  Fetch XML query data.

• pageCount
  Type: System.Int32

  Number records per Page

• pageNumber
  Type: System.Int32

  Current Page number

• pageCookie
  Type: System.String

  inbound place holder cookie

• outPageCookie
  Type: System.String

  outbound place holder cookie

• isMoreRecords
  Type: System.Boolean

  is there more records or not

• batchId
  Type: System.Guid

  Optional: if set to a valid GUID, generated by the Create Batch Request Method, will assigned the request to the batch for later execution, on fail, runs the request immediately

Return Value

Type: System.Collections.Generic.Dictionary<String, Dictionary<String, Object>>

results or null

See Also

GetEntityDataByFetchSearch Overload
CrmServiceClient Class
Microsoft.Xrm.Tooling.Connector Namespace

Return to top

© 2016 Microsoft. All rights reserved. Copyright