Gocator API
 All Classes Files Functions Variables Typedefs Macros Groups Pages
GoScript Class Reference

Description

Represents a ...

+ Inheritance diagram for GoScript:

Public Member Functions

kStatus GoScript_Code (GoScript tool, kChar **code)
 Gets the code for the script. More...
 
kStatus GoScript_SetCode (GoScript tool, kChar *code)
 Sets the code for the script. More...
 
GoMeasurement GoTool_FindMeasurementByType (GoTool tool, GoMeasurementType type)
 Retrieves the first found instance of a measurement for a given type. More...
 
GoMeasurement GoTool_MeasurementAt (GoTool tool, kSize index)
 Retrieves the measurement at the given index. More...
 
kSize GoTool_MeasurementCount (GoTool tool)
 Returns the measurement count. More...
 
kStatus GoTool_Name (GoTool tool, kChar *name, kSize capacity)
 Retrieves the name of the tool. More...
 
kStatus GoTool_SetName (GoTool tool, const kChar *name)
 Sets the name of the tool. More...
 

Member Function Documentation

kStatus GoScript_Code ( GoScript  tool,
kChar **  code 
)

Gets the code for the script.

Parameters
toolGoScript object.
codeReceives a null-terminated string containing the script code.
Returns
Operation status.
kStatus GoScript_SetCode ( GoScript  tool,
kChar *  code 
)

Sets the code for the script.

Parameters
toolGoScript object.
codeThe code to set.
Returns
Operation status.
GoMeasurement GoTool_FindMeasurementByType ( GoTool  tool,
GoMeasurementType  type 
)
inherited

Retrieves the first found instance of a measurement for a given type.

Parameters
toolGoTool object.
typeA GoMeasurementType representing the measurement type to find in the given tool.
Returns
A measurement object if one is found, otherwise kNULL.
GoMeasurement GoTool_MeasurementAt ( GoTool  tool,
kSize  index 
)
inherited

Retrieves the measurement at the given index.

Parameters
toolGoTool object.
indexThe index of the measurement.
Returns
The measurement.
kSize GoTool_MeasurementCount ( GoTool  tool)
inherited

Returns the measurement count.

Parameters
toolGoTool object.
Returns
The measurement count.
kStatus GoTool_Name ( GoTool  tool,
kChar *  name,
kSize  capacity 
)
inherited

Retrieves the name of the tool.

Parameters
toolGoTool object.
nameReceives the name of the tool.
capacityThe maximum capacity of the name array.
Returns
Operation status.
kStatus GoTool_SetName ( GoTool  tool,
const kChar *  name 
)
inherited

Sets the name of the tool.

Parameters
toolGoTool object.
nameThe name to be set for the tool.
Returns
Operation status.

The documentation for this class was generated from the following file: