Stg_WID_Abort, Stg_WID_AllowAutomaticReplenishment, Stg_WID_Discharge, Stg_WID_GetLastReplenishmentTime, Stg_WID_GetObjectiveWet, Stg_WID_GetReplenishmentRemainingTimeInSeconds, Stg_WID_GetReplenishmentTimePeriodInSeconds, Stg_WID_GetWaterInitiated, Stg_WID_Initiate, Stg_WID_Replenish, Stg_WID_WaitForFinish

Stg_WID_Abort

Description 

 Stg_WID_Abort();

This function is called whenever the Abort button is pressed in the GUI during initialization, replenishment or discharging.

Stg_WID_AllowAutomaticReplenishment

Description 

 Stg_WID_AllowAutomaticReplenishment(
   int  Allow
);

Pauses/runs the Water Immersion Dispenser.

Parameters

int Allow

0	WID is paused
1	WID is not paused

Stg_WID_Discharge

Description 

 Stg_WID_Discharge();

Discharges water from WID tubing. The macro continues to run without delay.

See Also

• Stg_WID_WaitForFinish

Stg_WID_GetLastReplenishmentTime

Description 

DWORD Stg_WID_GetLastReplenishmentTime();

Return Values

DWORD

The absolute time of the last replenishment in ms. 0 is the beginning of the current software session.

See Also

• Get_Time

Stg_WID_GetObjectiveWet

Description 

int Stg_WID_GetObjectiveWet();

Return Values

int

0	There is no water on the objective.
1	The objective is wet (WID was initiated in the past and has not yet been discharged).

Note

WID cannot physically remove water from objectives, so when the Stg_WID_Discharge function is called, a message box appears asking the user to clean (dry) the objective. From this moment, the Stg_WID_GetObjectiveWet returns 0.

Stg_WID_GetReplenishmentRemainingTimeInSeconds

Description 

int Stg_WID_GetReplenishmentRemainingTimeInSeconds();

Return Values

int

Number of seconds before the next automatic replenishment will occur.

Stg_WID_GetReplenishmentTimePeriodInSeconds

Description 

int Stg_WID_GetReplenishmentTimePeriodInSeconds();

Return Values

int

Current setting of the replenishment period - number of seconds between two automatic replenishments.

Stg_WID_GetWaterInitiated

Description 

int Stg_WID_GetWaterInitiated();

Determines whether the tubing is filled with water or no.

Return Values

int

0	Tubes are empty
1	Tubes are filled with water, replenishment can be started.

Stg_WID_Initiate

Description 

 Stg_WID_Initiate();

Starts the initialization of the water immersion dispenser (filling tubes with water and creating a water-drop on the objective). The macro continues to run without delay.

See Also

• Stg_WID_WaitForFinish

Stg_WID_Replenish

Description 

 Stg_WID_Replenish();

Starts the user-initiated water replenishment action. The macro continues to run without delay.

See Also

• Stg_WID_WaitForFinish

Stg_WID_WaitForFinish

Description 

 Stg_WID_WaitForFinish();

Forces the macro to wait until the action initiated by either of the following functions finishes.

See Also

• Stg_WID_Initiate

• Stg_WID_Replenish

• Stg_WID_Discharge