IOleContainer::LockContainer method

Keeps the container for embedded objects running until explicitly released.

Syntax

HRESULT LockContainer(
  BOOL fLock
);

Parameters

fLock

Indicates whether to lock (TRUE) or unlock (FALSE) a container.

Return Value

This method returns S_OK on success. Other possible return values include the following.

Return code Description
E_FAIL
The operation failed.
E_OUTOFMEMORY
Insufficient memory available for the operation.

Remarks

An embedded object calls LockContainer to keep its container running when the object has link clients that require an update. If an end user selects File Close from the container's menu, however, the container ignores all outstanding LockContainer locks and closes the document anyway.

Requirements

   
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header oleidl.h

See Also

CoLockObjectExternal

IOleContainer

IRunnableObject::Run