OleNoteObjectVisible

Increments or decrements an external reference that keeps the object in the running state.

STDAPI OleNoteObjectVisible(

LPUNKNOWN pUnknown,	//Points to an IUnknown instance
BOOL fVisible	//Indicates whether object is visible
);

Parameters
pUnknown
Points to an IUnknown instance for the object that is to be locked or unlocked.

fVisible
Indicates whether the object is visible. If TRUE, OLE holds the object visible and alive regardless of external or internal IUnknown::AddRef and IUnknown::Release operations; registrations; or revokes. If FALSE, OLE releases its hold and the object can be closed.

Return Values
S_OK

Indicates the object was successfully locked or unlocked.

E_OUTOFMEMORY

Indicates insufficient memory to perform the operation.

E_INVALIDARG

Indicates an invalid argument.

E_UNEXPECTED

Indicates an unexpected error.

Comments
The OleNoteObjectVisible function calls the CoLockObjectExternal function. It is provided as a separate function to reinforce the need to lock an object when it becomes visible to the user and to release the object when it becomes invisible. This creates a strong lock on behalf of the user to ensure that the object cannot be closed by its container while it is visible.