The
IGDACControlProbeSet interface provides access to control probe data. Control
probes were only accessible in the IGDACProbeSet
object for version 1.0 of the SDK. The control probe data are still available
in that object but are being deprecated in a future version of the SDK. Users
are encouraged to use this object to access control probe data.
COM ATTRIBUTES
Attribute
Type/Supported
Threading model
Both
Interface
Dual
Aggregation
No
ISupportErrorInfo
Yes
Connection Points
No
Free Threading Marshaler
No
PROPERTIES
NumQCProbes
ID
1
Description
The number of probes in the control probe set.
Type
long
Access
Read-only
Remarks
NA
QCType
ID
2
Description
The type of control probes.
Type
GDACFILES_QC_PROBESET_TYPE
Access
Read-only
Remarks
NA
ProbeSetType
ID
3
Description
The
type of probe set.
Type
GDACFILES_PROBESET_TYPE
Access
Read-only
Remarks
This will always be QC_PROBESET_TYPE.
METHODS
GetQCProbe
ID
4
Description
This function method returns a probe object.
Prototype
HRESULT
GetQCProbe([in] long nIndex, [in] IGDACProbe
*iQCProbe)
Parameters
long
nIndex - The index of the probe (input). IGDACProbe
*iQCProbe - Probe group object (input/output)
Return
HRESULT
- S_OK if successful, E_POINTER if iQCProbe is NULL or E_FAIL otherwise
Remarks
The user has to create the IGDACProbe
instance before passing it into the method.
The contents of the IGDACProbe
will be reset if the probe set has not been initialized.
GetQCProbes
ID
5
Description
This
function returns all probes in the probe set.
Prototype
HRESULT
GetQCProbes([in, out] VARIANT *iQCProbes)
Parameters
VARIANT
*iQCProbes - A variant structure holding the probe objects.
Return
HRESULT
- S_OK if successful or E_FAIL otherwise.
Remarks
This method will create individual IGDACProbe
instance for each probe element and add it to the variant array. The user can
use the NumQCProbes
to get the total number of probes available and iterate the variant array. It
is required to destroy each object inside the array after used.
The variant
will be returned empty if the probe set has not been initialized and set.
