Difference between revisions of "UniqueInstance"

From Free Pascal wiki
Jump to navigationJump to search
Line 33: Line 33:
=== History ===
=== History ===
* 16/12/06 - Initial release. See [http://lazarusroad.blogspot.com/2006/12/only-one-instance.html/ my blog] to know how it began.
* 16/12/06 - Initial release. See [http://lazarusroad.blogspot.com/2006/12/only-one-instance.html my blog] to know how it began.
=== Author ===
=== Author ===

Revision as of 04:05, 17 December 2006


UniqueInstance provides an easy way to force only one instance per application running at same time.


  • Easy of use: just drop a component in the main form
  • Provides a mechanism to receive the Command Line of the other instances

How To Use (Component)

Just drop in the main form


  • Enabled: enables/disables the component
  • Identifier: used to provides a way to identify the application


  • OnOtherInstance: called when another instance is initiated. Receives the parameters passed to that instance.

How To Use (Raw)

Add uniqueinstanceraw unit to your uses section.

Call the InstanceRunning function: it will return true if there's already a instance running. There are two variants: one with an Identifier argument (String) and one without. The second will use the executable name as the Identifier.


  • It was developed and tested under win32. I don't have a Linux machine at time
  • Although it does not use platform dependent code, the callback mechanic used to pass the command line probably won't work in Linux. This occurs because TSimpleIPCServer under Linux does not call the OnMessage event (At least until some months ago when i tested it).
  • If you put two TUniqueInstance components in the same application with the same identifier your application wont load.
  • The Identifier is optional both to the function and the component. In the case it's not used, the executable name is used as a Identifier. The consequence is that if someone changes the exe name another instance will not be identified.
  • To make sure a application will not avoid other launching you can use a GUID as the Identifier


  • 16/12/06 - Initial release. See my blog to know how it began.


Luiz Américo Pereira Câmara


Modified LGPL


Lazarus CCR sourceforge.