NAME

INST_READSTB − Compiled SCPI Commands
 

SYNOPSIS

 
INST_READSTB (id, c_addr);
 
 

DESCRIPTION

 
This is a Compiled SCPI macro command.  The instrument read status byte command places the results of a serial poll from the instrument specified by the id parameter in the address specified by the c_addr parameter.
 

PARAMETERS

id

The user variable name for the instrument.  This is the variable name that you assign to the instrument in the INST_DECL or INST_EXTERN command.  For example,
 
INST_DECL (vm, "E1411B", REGISTER);
 
assigns vm as an instrument data pointer to the E1411B.  Now when you use vm as the id in INST_READSTB, the HP E1411B is polled.
 

c_addr

The address where the results of the serial poll are stored.  Any valid C expression which evaluates to an unsigned character pointer can be used.  The preprocessor does not check to make sure that the c_addr parameter evaluates to an unsigned character pointer. 
 

COMMENTS

 
The c_addr parameter must evaluate to an unsigned character pointer.
 
For MESSAGE configurations, C-SCPI uses the HP SICL ireadstb() function.  See the HP SICL documentation for more information.
 

EXAMPLE

 
This example polls the HP E1411B and stores the results in the stb address location.
 

INST_DECL (vm, "E1411B", REGISTER);
 main()
{
unsigned char stb;
 INST_STARTUP();
INST_OPEN (vm, "VXI,24");
.
.
INST_READSTB (vm, &stb);
.
}

  —  December 04, 1992