GetMode

The function is described in the following sections.

Description

Fill in a structure detailing the modes supported by the sensor.

Syntax

The following code block shows the syntax of the function. 
GetMode(
    SENSOR_HANDLE *pstHandle,
    STF_U8 u8ModeIdx,
    SENSOR_MODE *pstModes
    );

Parameter

The function has the following parameters.
Table 1. GetMode Parameter Description
Parameter Description Input/Output
pstHandle Sensor handle Input
u8ModeIdx Sensor mode index Input
pstModes Sensor mode information Output

Return

The function has the following return values.
Table 2. GetMode Return Description
Return Description
0 Success
Other values Failure

Requirement

None