JCL Help:LockedSub@Int64@Int64

 JCL Help: LockedSub Function

JCL Functions

► JclSynch.pas Functions

[+] JclSynch.pas Functions

JEDI Code Library Help

• Packages
  • RTL enhancements
  • Containers
  • Developer Tools
  • VCL enhancements
• Files
  • Classes
  • Interfaces
  • Functions
  • Variables
  • Constants
  • Types
  • Records
• Project summary
• License

Search in JCL Help

 

Search in all projects

 

Summary

Thread safe subtraction.

Pascal

 function LockedSub(var Target: Integer; Value: Integer): Integer; overload;
function LockedSub(var Target: Int64; Value: Int64): Int64; overload;

Parameters

Parameters	Description
var Target: Integer	The Target variable to manipulate.
Value: Integer	The value to subtract from Target.

Return Value

The resulting value of Target after the subtraction. Note that the actual value of the variable may have already changed!

Description

LockedSub implements threadsafe subtraction for integers. The function subtracts Value from Target and returns the new value of Target. The LockedXxx functions allow for a simple and efficient way for applications to synchronize access to, and manipulate integer variables which are shared by multiple threads.

See Also

LockedAdd LockedExchange LockedInc LockedDec

About

Unit

JclSynch

Donator

Azret Botash

Notes

The Win32 API provides similar functions. Lookup InterlockedXxx in the Platform SDK.

Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page

The JEDI Code Library source code is hosted at : link to view the current source code, link to the subversion repository