The requested page is not available for the requested platform. You are viewing the content for .NET Framework 4.5.2+ platform.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

Session.GetObjectsFromSproc(XPClassInfo, LoadDataMemberOrderItem[], String, OperandValue[]) Method

Executes a stored procedure and returns its result set as a collection of non-persistent objects.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v19.2.dll

Declaration

public ICollection GetObjectsFromSproc(
    XPClassInfo classInfo,
    LoadDataMemberOrderItem[] members,
    string sprocName,
    params OperandValue[] parameters
)
Public Function GetObjectsFromSproc(
    classInfo As XPClassInfo,
    members As LoadDataMemberOrderItem(),
    sprocName As String,
    ParamArray parameters As OperandValue()
) As ICollection
public ICollection GetObjectsFromSproc(
    XPClassInfo classInfo,
    LoadDataMemberOrderItem[] members,
    string sprocName,
    params OperandValue[] parameters
)
Public Function GetObjectsFromSproc(
    classInfo As XPClassInfo,
    members As LoadDataMemberOrderItem(),
    sprocName As String,
    ParamArray parameters As OperandValue()
) As ICollection

Parameters

Name Type Description
classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the stored procedure's result set. The class must be decorated with NonPersistentAttribute.

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for classInfo members and the stored procedure's result set columns.

sprocName String

A String value that specifies the stored procedure's name.

parameters OperandValue[]

An array of OperandValue objects representing parameters to pass to the stored procedure.

Parameters

Name Type Description
classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the stored procedure's result set. The class must be decorated with NonPersistentAttribute.

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for classInfo members and the stored procedure's result set columns.

sprocName String

A String value that specifies the stored procedure's name.

parameters OperandValue[]

An array of OperandValue objects representing parameters to pass to the stored procedure.

Returns

Type Description
ICollection

A collection of non-persistent classInfo objects instantiated with data obtained via the specified stored procedure.

Returns

Type Description
ICollection

A collection of non-persistent classInfo objects instantiated with data obtained via the specified stored procedure.

Remarks

This method performs the following:

  • Executes the specified stored procedure with parameters and obtains the result as a result set.
  • Populates a collection with classInfo objects that are instantiated with the result set's data based on the mapping information passed as the members parameter. Note that classInfo should represent a non-persistent class decorated with a NonPersistentAttribute.
Note

The GetObjectsFromSproc method throws an exception if the members array includes any of the following classInfo members:

  • A property that is not defined within the classInfo object.
  • A struct type member.
  • A reference to a class with a struct type member.
  • A collection used in object relations.

To learn more about executing stored procedures in XPO and retrieving objects from the results, refer to Stored Procedures.

See Also