CommandText Property (FreshBooksCommand)

In This Topic

Gets or sets the SQL statement to execute against FreshBooks.

Syntax

Visual Basic
C#

'Declaration
 
Public Overrides Property CommandText As String

public override string CommandText {get; set;}

Property Value

The SQL statement to execute. The default value is an empty string ("").

Remarks

Sense of CommandText property depends on value of CommandType property.

When CommandType value is System.Data.CommandType.Text, property CommandText should contain text of a query that must be run on the server. It also may contain several SQL statements, separated with the semicolon. You may use parameters in all the statements. If there are several statements, returning data, use FreshBooksDataReader.NextResult to get all reader results.

When the value is System.Data.CommandType.StoredProcedure, property CommandText must be a name of a procedure to execute.

When the value is set to System.Data.CommandType.TableDirect, CommandText must be name of a table you want to get all data from. All rows and columns are retrieved.

Example

The following example creates a FreshBooksCommand and sets some of its properties.

csharp

public void CreateCommand()
{
  FreshBooksCommand freshbooksCommand = new FreshBooksCommand();
  freshbooksCommand.CommandText = "SELECT * FROM Client ORDER BY Id";
}

Visual Basic

Public Sub CreateCommand()
  Dim freshbooksCommand As New FreshBooksCommand()
  freshbooksCommand.CommandText = "SELECT * FROM Client ORDER BY Id"
End Sub

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 Class
FreshBooksCommand Members
Connection Property
CommandType Property
Parameters Property

Send Feedback