Share via


IOleControlSite::GetExtendedControl (Compact 2013)

3/26/2014

Requests an IDispatch pointer to the extended control that the container uses to wrap the real control.

Syntax

HRESULT GetExtendedControl( 
  IDispatch** ppDisp  
);

Parameters

  • ppDisp
    [out] Address of IDispatch* pointer variable that receives the interface pointer to the extended control. If an error occurs, the implementation must set *ppDisp to NULL. On success, the caller is responsible for calling IDispatch::Release when *ppDisp is no longer needed.

Return Value

This method supports the following return values:

Value

Description

S_OK

The extended control's IDispatch is returned in ppDisp.

E_NOTIMPL

The container does not implement extended controls.

E_OUTOFMEMORY

The call to the method failed due to lack of memory.

E_POINTER

The address in ppDisp or *ppDisp is not valid. For example, it may be NULL.

E_UNEXPECTED

The call to the method unexpectedly failed.

Remarks

This method gives the real control access to whatever properties and methods the container maintains in the extended control. These properties and methods would otherwise be inaccessible to the control.

Notes to Callers

The returned pointer is the responsibility of the caller, which must release it when it is no longer needed.

Requirements

Header

ocidl.h

See Also

Reference

IOleControlSite
COM Interfaces