|
CallbackWaveAnalyzerSpectralViewStartSet method |
  
|
|
CallbackWaveAnalyzerSpectralViewStartSet method |
|
Remarks
Sets the function of the CallbackWaveAnalyzerSpectralViewStart callback delegate which notifies when a new spectral view analysis begins.
For further details about callback delegates see the How to synchronize the container application with the API tutorial.
For details about the use of the Waveform Analyzer refer to the How to use the Waveform Analyzer section.
For further details about methods of the Waveform Analyzer refer to the WaveformAnalyzer class section.
Syntax
[Visual Basic] Public Function CallbackWaveAnalyzerSpectralViewStartSet ( function as CallbackWaveAnalyzerSpectralViewStart ) as enumErrorCodes |
[C#] public enumErrorCodes CallbackWaveAnalyzerSpectralViewStartSet ( CallbackWaveAnalyzerSpectralViewStart function ); |
[C++] public: enumErrorCodes CallbackWaveAnalyzerSpectralViewStartSet ( CallbackWaveAnalyzerSpectralViewStart function ); |
Parameter |
Description |
|
|
function |
Callback function |
when using the API from Unmanaged C++ through COM interaction, where the client application is totally unaware about .NET delegates, you should use the "Ptr" version of the method which allows passing the pointer to the callback function:
[Unmanaged C++] enumErrorCodes CallbackWaveAnalyzerSpectralViewStartSetPtr ( (UINT_PTR) functionPointer ); |
Parameter |
Description |
|
|
functionPointer |
Pointer to the callback function. See the Adding the API to an unmanaged Visual C++ project tutorial for details about usage of the "Ptr" version of these methods. |
Return value
Value |
Meaning |
|
|
Negative value |
An error occurred. Check the LastError property value in order to see the last error. |
enumErrorCodes.ERR_NOERROR (0) |
The method call was successful. |
