Reference Guide
interface IProductWithUtilities4
Definition
- interface IProductWithUtilities : IProduct2
- {
- HRESULT EnableToneGenerator([in] IProgrammer2* prg, [in] Ear ear, [in] VARIANT_BOOL enabled);
- HRESULT ReadLevelDetectors ([in] IProgrammer2* prg, [in] Ear ear, [in] long max,[out, size_is(max), length_is(*actual)] double* data,[out] long* actual);
- HRESULT ReadLevelDetectorsSafe(IProgrammer2* prg, [in] Ear ear, [in] long max
- HRESULT ScratchArrayToMemorySafe([in] SAFEARRAY(unsigned char)* data, [in, defaultvalue(-1)] long n, [out,retval] IMemory** rval);
- HRESULT MemoryToScratchArraySafe([in] IMemory* mem, [in] long max, [out] SAFEARRAY(unsigned char)* data);
- HRESULT ScratchArrayToMemorySafe([in] SAFEARRAY(unsigned char)* data, [in, defaultvalue(-1)] long n, [out,retval] IMemory** rval);
- HRESULT MemoryToScratchArraySafe([in] IMemory* mem, [in] long max, [out] SAFEARRAY(unsigned char)* data);
- };
- interface IProductWithUtilities2: IProductWithUtilities
- {
- HRESULT ReadVCLevel ([in] IProgrammer2* prg, [in] Ear ear, [out, retval] double* value);
- }
- interface IProductWithUtilities3 : IProductWithUtilities2
- {
- HRESULT SetGraphFrequencies([in] long n, [in, size_is(n)] double* data);
- HRESULT SetGraphFrequenciesSafe([in] SAFEARRAY(double)* data, [in, defaultvalue(-1)] long n);
- };
- interface IProductWithUtilities4 : IProductWithUtilities3
- {
- [propget]
-
- HRESULT MemoryMapCompatibility([out, retval] int* rval);
-
- [propput]
-
- HRESULT MemoryMapCompatibility([in] int comp);
-
};
Descriptions
| HRESULT EnableToneGenerator([in] IProgrammer2* prg, [in] Ear ear, [in] VARIANT_BOOL enabled); |
Enables or disables the tone generator, depending on the value of the enabled parameter.
|
| HRESULT ReadLevelDetectors([in] IProgrammer2* prg, [in] Ear ear, [in] long max, [out, size_is(max), length_is(*actual)] double* data,[out] long* actual); |
Reads the current values of the level detectors. max indicates the number of elements in the output array (normally 6). The elements in the returned array correspond to the various level detectors as follows: 0: Wideband, 1: Channel 1, 2: Channel 2, 3: Channel 3, 4: Channel 4, 5: AGCo. This method is intended for use with C and C++.
|
| HRESULT ReadLevelDetectorsSafe(IProgrammer2* prg, [in] Ear ear, [in] long max, [out] SAFEARRAY(double)*data); |
Reads the current values of the level detectors. See ReadLevelDetectors above for more details. This method is intended for use with Visual Basic, Matlab, and other development environments that implement arrays as SAFEARRAY structures.
|
| HRESULT InitScratch([in] longlength); |
Indicates how much scratch space is required (in bytes). This method must be called before any of the following methods.
|
| HRESULT ScratchArrayToMemory([in] long n, [in,size_is(n)] unsigned char* data, [out, retval] IMemory** rval); |
Converts an array of scratch data to a Memory object, prior to calling Burn. This method is intended for use with C and C++.
|
| HRESULT MemoryToScratchArray([in] IMemory* mem, [in] long max, [out, size_is(max), length_is(*actual)] unsigned char*data, [out] long* actual); |
Converts a Memory object back to an array of scratch data after the object had been created using GetFull then populated with data using ReadEx. This method is intended for use with C and C++.
|
| HRESULT ScratchArrayToMemorySafe([in]SAFEARRAY(unsigned char)* data, [in, defaultvalue(-1)] long n, [out,retval] IMemory ** rval); |
Converts an array of scratch data to a Memory object, prior to calling Burn. This method is intended for use with Visual Basic, Matlab, and other development environments that implement arrays as SAFEARRAY structures.
|
| HRESULT MemoryToScratchArraySafe([in] IMemory2* mem, [in] long max, [out] SAFEARRAY(unsigned char)* data); |
Converts a Memory object back to an array of scratch data after the object had been created using GetFull then populated with data using ReadEx. This method is intended for use with Visual Basic, Matlab, and other development environments that implement arrays as SAFEARRAY structures.
|
| HRESULT ReadVCLevel([in] IProgrammer2* prg, [in] Ear ear, [out, retval] double* value); |
Reads the current level of the volume control. This function returns a linear value between 0 and 1.0, where 1.0 corresponds to the maximum volume control setting. This value is only valid if the external volume control is enabled and the device has been calibrated.
|
| HRESULT SetGraphFrequencies([in] long n, [in, size_is(n)] double* data); |
Specifies a list of frequencies to use with CalcPointByFreqIndex in the IGraph2 interface. This method improves the performance of CalcPoint when the same set of frequencies are used repeatedly for graphing. This method is intended for use with C and C++.
|
| HRESULT SetGraphFrequenciesSafe([in] SAFEARRAY(double)* data, [in, defaultvalue(-1)] long n); |
Specifies a list of frequencies to use with CalcPointByFreqIndex in the IGraph2 interface. This method improves the performance of CalcPoint when the same set of frequencies are used repeatedly for graphing. This method is intended for use with Visual Basic, Matlab, and other development environments that implement arrays as SAFEARRAY structures.
|
[propget]
HRESULT MemoryMapCompatibility([out, retval] int* rval);
[propput]
HRESULT MemoryMapCompatibility([in] int comp); |
Indicates if the memory map is compatible with newer product libraries. Returns 1 if the memory map is compatible with newer product libraries.
|
|
