GetParam

Description

This COM method returns the value of the specified measurement parameter for the last measured object.


Syntax

[VB]
Value=objImageWarp.GetParam ( Param, Index )

[C/C++]
HRESULT GetParam( BSTR Param, int Index, float* pValue );


Data Types [VB]

Param: String
Index: Long
Return value: Single


Parameters [C/C++]

Param [in]

String specifying the name of the measurement parameter whose value is to be retrieved. See selectParam for the list of parameters supported by ImageWarp

Index [in]

Index of an element to be retrieved from a vector parameter. This argument is ignored for scalar parameters.

pValue [out,retval]

Pointer to the parameter's value

Return Values

S_OK

Success

E_FAIL

Failure.

Example

This VB code instructs ImageWarp to measure the histogram of image #1 and retrieves the 128-th element of the histogram array:.

IW.Call("measHistogram(1)")
While IW.Status <> SS_IDLE
Wend
value=IW.GetParam("Histogram", 128)
MsgBox value