IUnknown_RemoveBackReferences

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

Declaration

HRESULT IUnknown_RemoveBackReferences (IUnknown *punk);

Parameters

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

Return Value

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

Behaviour

The object is expected to implement the IObjectWithBackReferences 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 RemoveBackReferences method. The function then releases the interface pointer. The result of calling the method becomes the result of the function.

Availability

The IUnknown_RemoveBackReferences function is exported from SHLWAPI.DLL as ordinal 611 in the version 6.00 from Windows Vista, and higher.

Though new for Windows Vista, this function is not documented by Microsoft in the January 2007 edition of the Software Development Kit (SDK) for Windows Vista.