CWindow::GetDlgHost

Retrieves a pointer to an interface to the ATL Control hosting container.

HRESULT GetDlgHost( 
   int nID, 
   REFIID iid, 
   void** ppHost  
) throw();

Parameters

  • nID
    [in] The resource ID of the control being retrieved.

  • iid
    [in] The ID of the interface you would like to get from the control.

  • ppHost
    [out] The pointer to the interface.

Return Value

Returns S_OK if the window specified by iid is a Control Container, and the requested interface could be retrieved. Returns E_FAIL if the window is not a Control Container, or if the interface requested could not be retrieved. If a window with the specified ID could not be found, then the return value is equal to HRESULT_FROM_WIN32(ERROR_CONTROL_ID_NOT_FOUND).

Remarks

Using this pointer, you can call methods on the interface.

Requirements

Header: atlwin.h

See Also

Reference

CWindow Class

AtlAxGetHost