FreshBooksCommand Class

In This Topic

Syntax
Remarks
Example
Inheritance Hierarchy
Requirements
See Also

Represents a SQL statement or stored procedure to execute against FreshBooks.

Syntax

Visual Basic
C#

public class FreshBooksCommand : Devart.Data.SqlShimCommand, System.ComponentModel.IComponent, System.Data.IDbCommand, System.ICloneable, System.IDisposable

'Declaration
 
Public Class FreshBooksCommand 
   Inherits Devart.Data.SqlShimCommand
   Implements System.ComponentModel.IComponent, System.Data.IDbCommand, System.ICloneable, System.IDisposable

Remarks

The FreshBooksCommand class provides the following methods for executing commands against FreshBooks:

Item	Description
ExecuteReader	Executes commands that return rows.
Devart.Common.DbCommandBase.ExecutePageReader	Returns a specific subset of rows when paging through the results of a query.
ExecuteNonQuery	Executes SQL commands such as INSERT, DELETE, UPDATE.
ExecuteScalar	Retrieves a single value (for example, an aggregate value) from a data source.

If execution of the command results in a fatal FreshBooksException, the FreshBooksConnection may close. However, the user can reopen the connection and continue.

Example

The following example uses the ExecuteReader method of FreshBooksCommand, along with FreshBooksDataReader and FreshBooksConnection, to select rows from a table.

csharp

public void ReadMyData(string myConnString)
{
  string mySelectQuery = "SELECT Id, LastName FROM Client";
  FreshBooksConnection freshbooksConnection = new FreshBooksConnection(myConnString);
  FreshBooksCommand freshbooksCommand = new FreshBooksCommand(mySelectQuery,freshbooksConnection);
  freshbooksConnection.Open();
  FreshBooksDataReader freshbooksReader = freshbooksCommand.ExecuteReader();
  try
  {
    while (freshbooksReader.Read())
    {
      Console.WriteLine(freshbooksReader.GetString(0) + ", " + freshbooksReader.GetString(1));
    }
  }
  finally
  {
  // always call Close when done reading.
  freshbooksReader.Close();
  // always call Close when done reading.
  freshbooksConnection.Close();
  }
}

Visual Basic

Public Sub ReadMyData(myConnString As String)
  Dim mySelectQuery As String = "SELECT Id, LastName FROM Client"
  Dim freshbooksConnection As New FreshBooksConnection(myConnString)
  Dim freshbooksCommand As New FreshBooksCommand(mySelectQuery, freshbooksConnection)
  freshbooksConnection.Open()
  Dim freshbooksReader As FreshBooksDataReader = freshbooksCommand.ExecuteReader()
  Try
    While freshbooksReader.Read()
      Console.WriteLine(freshbooksReader.GetString(0) + ", " _
        + freshbooksReader.GetString(1))
    End While
  Finally
      ' always call Close when done reading.
      freshbooksReader.Close()
      ' always call Close when done with connection.
      freshbooksConnection.Close()
  End Try
End Sub

Inheritance Hierarchy

System.Object
   System.MarshalByRefObject
      System.ComponentModel.Component
         System.Data.Common.DbCommand
            Devart.Common.DbCommandBase
               Devart.Data.SqlShimCommand
                  Devart.Data.FreshBooks.FreshBooksCommand

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

FreshBooksCommand Members
Devart.Data.FreshBooks Namespace
FreshBooksDataReader Class
FreshBooksConnection Class

Send Feedback