SPDataSourceView.GetQueryAndFieldStringFromSelectCommand method

Parses a request for data from a data-bound control.

Namespace:  Microsoft.SharePoint.WebControls
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
Protected Function GetQueryAndFieldStringFromSelectCommand ( _
    <OutAttribute> ByRef formattedQuery As String, _
    <OutAttribute> ByRef formattedViewFields As String, _
    <OutAttribute> ByRef formattedList As String, _
    <OutAttribute> ByRef formattedWeb As String, _
    <OutAttribute> ByRef fieldList As String(), _
    <OutAttribute> ByRef nRowLimit As UInteger, _
    queryParameters As SortedList(Of String, Object), _
    selectArguments As DataSourceSelectArguments _
) As Boolean
'Usage
Dim formattedQuery As String
Dim formattedViewFields As String
Dim formattedList As String
Dim formattedWeb As String
Dim fieldList As String()
Dim nRowLimit As UInteger
Dim queryParameters As SortedList(Of String, Object)
Dim selectArguments As DataSourceSelectArguments
Dim returnValue As Boolean

returnValue = Me.GetQueryAndFieldStringFromSelectCommand(formattedQuery, _
    formattedViewFields, formattedList, _
    formattedWeb, fieldList, nRowLimit, _
    queryParameters, selectArguments)

protected bool GetQueryAndFieldStringFromSelectCommand(
    out string formattedQuery,
    out string formattedViewFields,
    out string formattedList,
    out string formattedWeb,
    out string[] fieldList,
    out uint nRowLimit,
    SortedList<string, Object> queryParameters,
    DataSourceSelectArguments selectArguments
)

Parameters

• formattedQuery
  Type: System.String

  A reference to an output variable to receive a Collaborative Application Markup Language (CAML) fragment formatted in accordance with the query schema. For more information, see Query Schema.

• formattedViewFields
  Type: System.String

  A reference to an output variable to receive a CAML fragment formatted as a ViewFields element. For more information, see ViewFields Element (List).

• formattedList
  Type: System.String

  A reference to an output variable to receive a CAML fragment formatted as a Lists element. For more information, see Lists Element (Site) .

• formattedWeb
  Type: System.String

  A reference to an output variable to receive a CAML fragment formatted as a Webs element. For more information, see the Webs property.

• fieldList
  Type: []

  A reference to an array variable to receive the names of any fields passed in a ViewFields element.

• nRowLimit
  Type: System.UInt32

  A reference to an output variable to receive any value passed in a RowLimit element. For more information, see RowLimit Element (List).

• queryParameters
  Type: System.Collections.Generic.SortedList<String, Object>

  A sorted list of query parameters as key/value pairs.

• selectArguments
  Type: System.Web.UI.DataSourceSelectArguments

  An object that represents a request from the data-bound control.

Return value

Type: System.Boolean
true

See also

Reference

SPDataSourceView class

SPDataSourceView members

Microsoft.SharePoint.WebControls namespace