beautypg.com

Shsastart, Arguments returns remarks – Bird Technologies SignalHawk User Manual

Page 33

background image

Reference

21

shSaStart

This function starts a measurement with the specified parameters.

int BIRD_SH_API shSaStart(

shConnection_t* Connection,
shSaParameters_t* Parameters
);

Arguments

Returns

Returns an error code indicating the status of the operation:

Remarks

shSaGetData(…)should be called to get the data for all measure-
ments except shSaMeasurementTypes::Demodulation for which
shSaGetDemodData(…) should be called.

shSaStop() should be called to terminate the operation even when in
single sweep mode.

Connection

Pointer to a structure of type
shConnection_t which specifies a
connection previously established with
shConnect(…) or
shConnectDefault(…).

Parameters Pointer

to

a structure of type

shSaParameters_t which specifies the
parameters for the measurement to be
made. The fields in the structure which
must be specified depend on the type of
measurement.

ERROR_SUCCESS

The start operation was successful.

SH_ERROR_INVALID_
ARGUMENT

One or of the arguments was not a valid
object.

SH_ERROR_DEVICE_NOT_
CONNECTED

No device is connected.

SH_ERROR_SELECTED_
DEVICE_NOT_CONNECTED

The specified device is not connected.

SH_ERROR_..._INVALID

One of the measurement parameters
was out of range. See the Error
Reference for more detail on all the
parameter range errors.

Others Call

shGetLastError() for information on

the specific error.