|
CallbackPercentageSet method |
  
|
|
CallbackPercentageSet method |
|
Remarks
Sets the function of the CallbackPercentage callback delegate which notifies about percentage of advancement for lengthy operations running inside a secondary thread.
For further details about callback delegates see the How to synchronize the container application with the API tutorial.
Syntax
[Visual Basic] Public Function CallbackPercentageSet ( function as CallbackPercentage ) as enumErrorCodes |
[C#] public enumErrorCodes CallbackPercentageSet ( CallbackPercentage function ); |
[C++] public: enumErrorCodes CallbackPercentageSet ( CallbackPercentage 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 CallbackPercentageSetPtr ( (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. |
