IUnknown_EnableModeless

Given an arbitrary interface pointer to an object, this function calls the object’s EnableModeless method.

Declaration

HRESULT
IUnknown_EnableModeless (
    IUnknown *punk,
    BOOL fEnable);

Parameters

The punk argument is any interface pointer for the object of interest.

The fEnable argument is for the object’s EnableModeless method.

Return Value

The function returns zero for success, else an error code.

Behaviour

The object is expected to implement at least one of the following interfaces: IOleInPlaceActiveObject, IInternetSecurityMgrSite, IOleInPlaceFrame, IShellBrowser and IDocHostUIHandler.

If the punk argument is NULL, then there is no object to query for the expected interfaces, and the function returns E_FAIL. Interfaces are queried in the order given above. If the object does not implement any of the expected interfaces, the function returns the result of its last call to QueryInterface.

Once the function has obtained a pointer to an expected interface for the given object, it uses this interface pointer to call the EnableModeless method (or EnableModelessSB if the interface found is IShellBrowser). The fEnable argument is passed as given. The function then releases the interface pointer. The result of calling the method becomes the result of the function.

Availability

The IUnknown_EnableModeless function is exported from SHLWAPI.DLL as ordinal 355 in version 5.00 and higher.

Though this function dates from as long ago as 1999, it was still not documented by Microsoft in the MSDN Library at least as late as the CD edition dated January 2004.