IUnknown_OnFocusOCS

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

Declaration

HRESULT
IUnknown_OnFocusOCS (
    IUnknown *punk,
    BOOL fGotFocus);

Parameters

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

The fGotFocus argument is for the object’s OnFocus method.

Return Value

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

Behaviour

The object is expected to implement the IOleControlSite interface.

If the punk argument is NULL, then there is no object to query for the expected interface, and the function returns E_FAIL. If the object does not implement the expected interface, the function returns the result from the failed QueryInterface.

Once the function has obtained a pointer to the expected interface for the given object, it uses this interface pointer to call the OnFocus method. The fGotFocus 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_OnFocusOCS function is exported from SHLWAPI.DLL as ordinal 189 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.