ReleaseLock Method (IWorkbookSet)

Releases a lock acquired with GetLock and starts background calculation if appropriate.

Syntax

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration
 
Sub ReleaseLock()

'Usage
 
Dim instance As IWorkbookSet
 
instance.ReleaseLock()

void ReleaseLock()

procedure ReleaseLock();

function ReleaseLock();

void ReleaseLock();

void ReleaseLock();

Remarks

This method is thread safe.

Calls to GetLock may be nested. ReleaseLock must be called once for each call to GetLock.

Interruptible background calculation will be started if the following conditions are all met:

The last lock acquired by the current thread is being released.
There are no other threads waiting to acquire a lock on this workbook set.
BackgroundCalculation is set to true.
Calculation is not set to Calculation.Manual.

Example

Demonstrate using a workbook set in a thread safe manner.

void DoSomeThreadSafeWork(IWorkbookSet workbookSet)
        {
            // Interrupt background calculation if necessary and acquire an
            // exclusive lock on the workbook set.
            workbookSet.GetLock();
 
            try {
                // Do some work...
            }
            finally {
                // Release the lock on the workbook set and start background
                // calculation if appropriate.
                workbookSet.ReleaseLock();
            }
        }

Visual Basic

Sub DoSomeThreadSafeWork(ByVal workbookSet As IWorkbookSet)
            ' Interrupt background calculation if necessary and acquire an 
            ' exclusive lock on the workbook set. 
            workbookSet.GetLock()
 
            Try
                ' Do some work... 
            Finally
                ' Release the lock on the workbook set and start background 
                ' calculation if appropriate. 
                workbookSet.ReleaseLock()
            End Try
        End Sub 'DoSomeThreadSafeWork

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

IWorkbookSet Interface
IWorkbookSet Members
HasLock Property
GetLock Method
ReleaseLock Method
RewindLock Method
UnwindLock Method
BeginUpdate Method
EndUpdate Method
BackgroundCalculation Property