Export (0) Print
Expand All

IObjectWithSite::GetSite Method

Gets the last site set with IObjectWithSite::SetSite. If there is no known site, the object returns a failure code.

Syntax


HRESULT GetSite(
    REFIID riid,
    void **ppvSite
);

Parameters

riid
[in] The IID of the interface pointer that should be returned in ppvSite.
ppvSite
[out] The address of the caller's void* variable in which the object stores the interface pointer of the site last seen in IObjectWithSite::SetSite. The specific interface returned depends on the riid argument; the two arguments act identically to those in QueryInterface. If the appropriate interface pointer is available, the object must call AddRef on that pointer before returning successfully. If no site is available, or the requested interface is not supported, the object sets this argument to NULL, and returns a failure code.

Return Value

Returns one of the following values.

S_OK The site was returned successfully, and the caller is responsible for calling ((IUnknown *)(*ppvSite))->Release() when the site is no longer needed.
E_FAIL There is no site; in that case, *ppvSite contains NULL on return.
E_NOINTERFACE There is a site, but it does not support the interface requested by riid.

Remarks

E_NOTIMPL is disallowed. Any object that implements this interface must be able to return the last site seen in IObjectWithSite::SetSite.

Community Additions

ADD
Show:
© 2014 Microsoft