Assembly: Quanser.Hardware.Hil (in Quanser.Hardware.Hil.dll)
Syntax
Visual Basic (Declaration) |
---|
Public Sub SetCardSpecificOptions ( _ options As String _ ) |
C# |
---|
public void SetCardSpecificOptions( string options ) |
Visual C++ |
---|
public: void SetCardSpecificOptions( String^ options ) |
JavaScript |
---|
function setCardSpecificOptions(options); |
Parameters
- options
- Type: System..::.String
A string containing the options. See the standard format of this argument in the discussion above.
Select a board type from the list for board-specific details: .
Remarks
The SetCardSpecificOptions method sets the sets options specific to a particular card. The options parameter is a string containing the card-specific options. The string typically takes the form:
<name>=<value>,<name>=<value>,...
where <name> is the name of an option and <value> is the option's value. In general, spaces should be avoided. Spaces may be contained in values if the value is enclosed in double quotes. For example, in the hypothetical options string below, the value of the vendor option contains a space so it is enclosed in quotes.
"vendor=\"National Instruments\",terminal_board=e_series"
Refer to the card's documentation for details on the options supported by the card. Many cards do not support any options since the standard Hil methods cover most, if not all, of their functionality.
Examples
C# | Copy Code |
---|---|
board.SetCardSpecificOptions("terminal_board=e_series"); |
Visual Basic | Copy Code |
---|---|
board.SetCardSpecificOptions("terminal_board=e_series") |
Visual C++ | Copy Code |
---|---|
board->SetCardSpecificOptions(L"terminal_board=e_series"); |
Exceptions
Exception | Condition |
---|---|
Quanser.Hardware..::.HilException | If the options cannot be set then an exception is thrown. This situtation typically arises when invalid options are specified, although some boards may simply ignore invalid options. |