> For the complete documentation index, see [llms.txt](https://manuals.blusapphire.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://manuals.blusapphire.io/blugenie/full-function-list/invoke-blugeniethreadlock.md). # Invoke-BluGenieThreadLock ### Invoke-BluGenieThreadLock ### SYNOPSIS Create a named Mutex ### SYNTAX ``` Invoke-BluGenieThreadLock [-ShowLocks] [-Walkthrough] [] Invoke-BluGenieThreadLock [-setLock] [[-lockName] ] [-timeOut ] [-GlobalName ] [-Walkthrough] [] Invoke-BluGenieThreadLock [-releaseLock] [[-lockName] ] [-timeOut ] [-GlobalName ] [-Walkthrough] [] ``` ### DESCRIPTION With a named mutex, we can specify a mutex with a name on one process and then tell it to take the mutex and on another process (yes, another PowerShell console would work) and call the same named mutex and if we attempt to take the mutex, it will create a blocking call until the other process relinquishes control of it. What this allows us to do is have multiple processes that can write to a single file without fear of missing data due to the file being locked. ### EXAMPLES #### EXAMPLE 1 ``` Command: $mtx = Invoke-BluGenieMutux -Name Log ``` ``` $mtx.WaitOne() 'other important data' | Out-File C:\importantlogfile.txt -Append $mtx.ReleaseMutex()Description: Create Mutux Threading to lock Logging file. Notes: ..EXAMPLE Command: $mtx = Invoke-BluGenieMutux -Name Log $mtx.WaitOne(1000) 'other important data' | Out-File C:\importantlogfile.txt -Append $mtx.ReleaseMutex()Description: Create Mutux Threading with a 1000 second timeout. Notes: ``` #### EXAMPLE 2 ``` -Help ``` ``` Description: Call Help Information Notes: If Help / WalkThrough is setup as a parameter, this script will be called to setup the Dynamic Help Menu if not the normal Get-Help will be called with the -Full parameter ``` #### EXAMPLE 3 ``` -WalkThrough ``` ``` Description: Call Help Information [2] Notes: If Help / WalkThrough is setup as a parameter, this script will be called to setup the Dynamic Help Menu if not the normal Get-Help will be called with the -Full parameter ``` ### PARAMETERS #### setLock ``` -setLock [] Required? false Position? named Default value False Accept pipeline input? false Accept wildcard characters? false ``` #### releaseLock ``` -releaseLock [] Required? false Position? named Default value False Accept pipeline input? false Accept wildcard characters? false ``` #### lockName ``` -lockName Required? false Position? 2 Default value ThreadLock Accept pipeline input? false Accept wildcard characters? false ``` #### timeOut ``` -timeOut Required? false Position? named Default value 600 Accept pipeline input? false Accept wildcard characters? false ``` #### GlobalName ``` -GlobalName Required? false Position? named Default value MyLock Accept pipeline input? false Accept wildcard characters? false ``` #### ShowLocks ``` -ShowLocks [] Required? false Position? named Default value False Accept pipeline input? false Accept wildcard characters? false ``` #### Walkthrough ``` -Walkthrough [] Description: Start the dynamic help menu system to help walk through the current command and all of the parameters Notes: Alias: Help ValidateSet: Required? false Position? named Default value False Accept pipeline input? false Accept wildcard characters? false ``` #### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about\_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).