Measurement Computing Data Acquisition Systems rev.10.4 - Manual (Page 46)

Command Information Layout
Note: The “daqAPICommand” name, used below, is for illustrative purposes only.
daqAPICommand
{the API Command name, often referred to as a “Function”}
{related commands, if applicable} Also See: daqAPICommand2, daqAPICommand3
Format
daqAPICommand(parameter1, parameter2, parameter3)
Purpose
daqAPICommand
does ….
{this is a brief description of the command’s purpose} .
Parameter Summary
Parameter Type Description
parameter1 DataTypeA Briefly states the function of parameter1.
parameter2 DataTypeB Briefly states the function of parameter2.
parameter3 DataTypeC Briefly states the function of parameter3.
Parameter Values
parameter1: valid value range for parameter1
parameter2: valid value range for parameter2
parameter3: valid value range for parameter3
Parameter Type Definitions
Data Type Definitions - DataTypeA
Description Description
ParamValue1 Describes result of setting DataTypeA to parameter value 1
ParamValue2 Describes result of setting DataTypeA to parameter value 2
ParamValue3 Describes result of setting DataTypeA to parameter value 3
Returns
ReturnMessage1 Return Message definition
“Returns” lists possible return messages that could result from the use of the command. An error
message is a return; and all Error information can be found in the Daq Error Table. Not that some
commands have no returns.
Function Usage
The function usgage section provides additional information about the various parameters and their
possible values. The information usually expands upon that which is presented in the Parameter
Summary and Parameter Values tables. For clarity, this section may include sub-sections which discuss
groups of parameters; such as parameters that deal with input and output, or parameters which must be
used together to accomplish a result (such as a parameter which arms a counter, and another that
configures the counter’s starting value). The Function Usage subsections may also discuss broader Daq
programming concepts.
4.1-2 Daq API Command Reference 938395 Programmer’s Manual