Verastream Host Integrator .Net Reference

HostIntegratorSession.PerformTableProcedure Method (String, String, IDictionary, Boolean, IList, Int32)

Performs a SELECT procedure on a table defined in the model.

[Visual Basic]
Overloads Public Function PerformTableProcedure( _
   ByVal tableName As String, _
   ByVal procedureName As String, _
   ByVal filterValues As IDictionary, _
   ByVal filterIsCaseSensitive As Boolean, _
   ByVal outputColumnNames As IList, _
   ByVal maxRows As Integer _
) As DataSet
[C#]
public DataSet PerformTableProcedure(
   string tableName,
   string procedureName,
   IDictionary filterValues,
   bool filterIsCaseSensitive,
   IList outputColumnNames,
   int maxRows
);

Parameters

tableName
Specifies the name of the table on which to perform the procedure.
procedureName
Specifies the name of the table procedure to perform.
filterValues
Specifies a set of filter column name-value pairs to use.
filterIsCaseSensitive
Specifies whether the filter comparison should be case sensitive.
outputColumnNames
Specifies the names of the columns to return.
maxRows
Specifies the maximum number of rows to return. If maxRows is set to 0, no limit is imposed on the number of rows returned.

Return Value

This method returns the result of a SELECT procedure. If no data match the specified conditions, this method returns an empty DataSet.

Remarks

Performs a SELECT procedure on a table defined in the model.

Exceptions

Exception TypeCondition
HostIntegratorModelDefExceptionThrown if a reference is made to a non-existent table, procedure, or table column
HostIntegratorConnectorExceptionThrown if client is not connected
HostIntegratorExceptionThrown if the connection is for metadata only
HostIntegratorServerExceptionThrown if an error occurs while performing the procedure

See Also

HostIntegratorSession Class | HostIntegratorSession Members | WRQ.Verastream.HostIntegrator Namespace | HostIntegratorSession.PerformTableProcedure Overload List