IViewObject::GetAdvise (Compact 2013)

3/26/2014

This method retrieves the advisory connection on the object if there is one and returns the parameters used in the most recent call to the IViewObject::SetAdvise method.

Syntax

HRESULT GetAdvise( 
  DWORD* pdwAspect, 
  DWORD* padvf, 
  IAdviseSink** ppAdvSink
);

Parameters

• pdwAspect
  [out] Pointer to where the dwAspect parameter from the previous SetAdvise call is returned.

  If this pointer is NULL, the caller does not permit this value to be returned.

• padvf
  [out] Pointer to where the advf parameter from the previous SetAdvise call is returned.

  If this pointer is NULL, the caller does not permit this value to be returned.

• ppAdvSink
  [out] Address of IAdviseSink* pointer variable that receives the interface pointer to the advise sink.

  The connection to this advise sink must have been established with a previous SetAdvise call, which provides the pAdvSink parameter.

  If *ppvAdvSink is NULL, there is no established advisory connection.

Return Value

This method supports the standard return values E_INVALIDARG and E_OUTOFMEMORY, as well S_OK, which indicates that the existing advisory connection was retrieved.

Remarks

To determine whether the platform supports this interface, see Determining Supported COM APIs.

Requirements

Header	Oleidl.h, oleidl.idl
Library	oleaut32.lib, uuid.lib

See Also

Tasks

Determine Supported COM APIs

Reference

IViewObject
IViewObject::SetAdvise