Add Procedure
Sets a function as valid for Mutexes.
Used from a subscriber to the OnAddFunctions event.
Overloads
| Name | Description |
|---|---|
| Add(Code[20]; Text[50]) | Sets a function as valid for Mutexes. |
| Add(Code[20]; Text[50]; Integer) | Sets a function as valid for Mutexes, with a configured timeout. |
Add(Code[20]; Text[50]) Procedure
Sets a function as valid for Mutexes.
Used from a subscriber to the OnAddFunctions event.
Signature
Add(NewFunctionCode: Code[20]; NewDescription: Text[50])
Parameters
NewFunctionCode Code[20]
The code of the feature that should be able to use mutexes.
NewDescription Text[50]
A description of this feature, that could be shown in error messages.
Remarks
This function should be called by all subscribers to the OnAddFunctions event.
Add(Code[20]; Text[50]; Integer) Procedure
Sets a function as valid for Mutexes, with a configured timeout.
Used from a subscriber to the OnAddFunctions event.
Signature
Add(NewFunctionCode: Code[20]; NewDescription: Text[50]; TimeoutMS: Integer)
Parameters
NewFunctionCode Code[20]
The code of the feature that should be able to use mutexes.
NewDescription Text[50]
A description of this feature, that could be shown in error messages.
TimeoutMS Integer
The timeout in milliseconds for this feature, that is used when obtaining a mutex. If the process to obtain the mutex takes longer than the timeout, the mutex is not obtained and an error is thrown.
If a timeout is set, the function ObtainMutex must be called with the WithCommit parameter set to true.
Remarks
This function should be called by all subscribers to the OnAddFunctions event.
This documentation is generated from Smart Toolbox v27.0