_Stg_NosepieceSetup, Stg_GetNosepieceObjectiveCode, Stg_GetNosepieceObjectiveName, Stg_GetNosepieceObjectiveRefractiveIndex, Stg_GetNosepiecePosition, Stg_GetNosepiecePositions, Stg_GetObjectiveNameFromCode, Stg_IsNosepiecePresent, Stg_Nosepiece_EnableRotation, Stg_SetNosepieceObjective, Stg_SetNosepieceObjectiveName, Stg_SetNosepiecePosition

Stg_GetObjectiveNameFromCode

Description 

 Stg_GetObjectiveNameFromCode(
   char *LpObjectiveCode,
   char *LpObjectiveName,
   int  ObjectiveNameMaxLength
);

This function returns the Objective name.

Parameters

char *LpObjectiveCode

Objective code to be filled.

char *LpObjectiveName

Objective name to be filled.

int ObjectiveNameMaxLength

Maximal optical configuration name length. If the name has more characters than defined, it is shortened automatically.

Stg_GetNosepieceObjectiveCode

Description 

 Stg_GetNosepieceObjectiveCode(
   int  NosepiecePosition,
   char *LpObjectiveCode,
   int  ObjectiveNameMaxLength
);

Returns the code of the given nosepiece objective position.

Parameters

int NosepiecePosition

Index number of the nosepiece position.

char *LpObjectiveCode

Objective code to be filled.

int ObjectiveNameMaxLength

Maximal optical configuration name length. If the name has more characters than defined, it is shortened automatically.

See Also 
Stg_IsNosepiecePresent, Stg_GetNosepiecePositions, Stg_SetNosepieceObjective, Stg_GetNosepieceObjectiveName

Stg_GetNosepieceObjectiveName

Description 

 Stg_GetNosepieceObjectiveName(
   int  NosepiecePosition,
   char *Name,
   int  maxLength
);

Retrieves the objective name assigned to the specified nosepiece.

Parameters

int NosepiecePosition

Index number of the nosepiece position.

char *Name

Name of the objective used in the Nosepiece and Objectives dialog window.

int maxLength

Name buffer length is the maximal number of characters which can be stored to filter name buffer.

Return Values

DR_OK (1)	Nosepiece objective position name was stored to character buffer
DR_BADPARAMETER (-2)	Some parameter has invalid value
DR_NOTAVAILABLE (-4)	Device Nosepiece is not present
DR_CANCELED (0)	Nosepiece objective position name is longer than length of character buffer
DR_UNKNOWNERROR (-1)	Retrieving the nosepiece objective position name failed

See Also 
Stg_IsNosepiecePresent, Stg_GetNosepiecePositions, Stg_SetNosepieceObjective, Stg_GetNosepieceObjectiveCode

Stg_GetNosepieceObjectiveRefractiveIndex

Description 

 Stg_GetNosepieceObjectiveRefractiveIndex(
   int  NosepiecePosition
);

Returns the refractive index of the current nosepiece position.

Parameters

int NosepiecePosition

Index number of the nosepiece position.

Stg_GetNosepiecePosition

Description 

 Stg_GetNosepiecePosition();

Returns the current nosepiece objective position.

Return Values

Value >= 0	Current nosepiece objective position
DR_NOTAVAILABLE (-4)	Device Nosepiece is not present
DR_UNKNOWNERROR (-1)	Retrieving the current nosepiece objective position failed

See Also 
Stg_IsNosepiecePresent

Stg_GetNosepiecePositions

Description 

 Stg_GetNosepiecePositions();

Returns the number of nosepiece objective positions.

Return Values

Value > 0	Number of nosepiece objective positions
DR_NOTAVAILABLE (-4)	Device Nosepiece is not present
DR_UNKNOWNERROR (-1)	Retrieving the number of nosepiece objective positions failed

See Also 
Stg_IsNosepiecePresent

Stg_IsNosepiecePresent

Description 

 Stg_IsNosepiecePresent();

Detects whether the nosepiece is available or not.

Return Values

TRUE (1)	Nosepiece is present
FALSE (0)	Nosepiece is not present

See Also 
Stg_GetNosepiecePositions, Stg_SetNosepiecePosition, Stg_GetNosepiecePosition, Stg_SetNosepieceObjective, _Stg_NosepieceSetup

Stg_Nosepiece_EnableRotation

Description 

 Stg_Nosepiece_EnableRotation(
   int  Rotationenable
);

This function is used for the purposes of the water immersion dispenser, rotation of the nosepiece is blocked if water is present on the objective.

Parameters

int Rotationenable

0	Block nosepiece rotation
1	Enable nosepiece rotation

Stg_SetNosepieceObjective

Description 

 Stg_SetNosepieceObjective(
   char *LpObjectiveName
);

Sets the current nosepiece objective position with the given name.

Parameters

char *LpObjectiveName

The nosepiece objective name.

Return Values

DR_OK (1)	Nosepiece objective position was set
DR_BADPARAMETER (-2)	Some parameter has invalid value
DR_NOTAVAILABLE (-4)	Device Nosepiece is not present
DR_UNKNOWNERROR (-1)	Setting nosepiece objective position failed

See Also 
Stg_IsNosepiecePresent, Stg_SetNosepieceObjectiveName, Stg_GetNosepieceObjectiveName

Stg_SetNosepieceObjectiveName

Description 

 Stg_SetNosepieceObjectiveName(
   int  NosepiecePosition,
   char *LpObjectiveName
);

Sets the objective specified by the LpObjectiveName parameter to a given nosepiece position set by the NosepiecePosition parameter.

Parameters

int NosepiecePosition

Index number of the nosepiece position.

char *LpObjectiveName

The nosepiece objective name.

Return Values

DR_OK (1)	Nosepiece objective position name was set
DR_BADPARAMETER (-2)	Some parameter has invalid value
DR_NOTAVAILABLE (-4)	Device Nosepiece is not present
DR_UNKNOWNERROR (-1)	Setting the nosepiece objective position name failed

See Also 
Stg_IsNosepiecePresent, Stg_GetNosepiecePositions, Stg_SetNosepieceObjective

Stg_SetNosepiecePosition

Description 

 Stg_SetNosepiecePosition(
   int  NosepiecePosition
);

Sets the current nosepiece objective position.

Parameters

int NosepiecePosition

Index number of the nosepiece position.

Return Values

DR_OK (1)	Nosepiece objective position was set
DR_BADPARAMETER (-2)	Some parameter has invalid value
DR_NOTAVAILABLE (-4)	Device Nosepiece is not present
DR_UNKNOWNERROR (-1)	Setting nosepiece objective position failed

See Also 
Stg_IsNosepiecePresent, Stg_GetNosepiecePositions

_Stg_NosepieceSetup

Description 

int _Stg_NosepieceSetup();

Displays a dialog box allowing the user to set the nosepiece objective position names.

Return Values

int

1, DR_OK

Nosepiece setup was confirmed

See Also 
Stg_IsNosepiecePresent