OleNoteObjectVisible function
Increments or decrements an external reference that keeps an object in the running state.
Syntax
HRESULT OleNoteObjectVisible( _In_ LPUNKNOWN pUnknown, _In_ BOOL fVisible );
Parameters
- pUnknown [in]
-
Pointer to the IUnknown interface on the object that is to be locked or unlocked.
- fVisible [in]
-
Whether the object is visible. If TRUE, OLE increments the reference count to hold the object visible and alive regardless of external or internal IUnknown::AddRef and IUnknown::Release operations, registrations, or revocation. If FALSE, OLE releases its hold (decrements the reference count) and the object can be closed.
Return value
This function returns S_OK on success. Other possible values include the following.
| Return code | Description |
|---|---|
|
Insufficient memory for the operation. |
|
One or more parameters are invalid. |
|
An unexpected error occurred. |
Remarks
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.
Requirements
|
Minimum supported client |
Windows 2000 Professional [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows 2000 Server [desktop apps only] |
|
Header |
|
|
Library |
|
|
DLL |
|
See also