IViewObject::GetAdvise

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

HRESULT GetAdvise(
  DWORD * pdwAspect,  //Pointer to where dwAspect parameter from 
                      //previous SetAdvise call is returned
  DWORD * padvf,      //Pointer to where advf parameter from 
                      //previous SetAdvise call is returned
  IAdviseSink ** ppAdvSink
                      //Address of output variable that receives the 
                      //IAdviseSink interface pointer
);
 

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 Values

This method supports the standard return values E_INVALIDARG and E_OUTOFMEMORY, as well as the following:

S_OK

The existing advisory connection was retrieved.

QuickInfo

  Windows NT: Use version 3.1 or later.
  Windows: Use Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in oleidl.h.

See Also

ADVF, IAdviseSink, IViewObject::SetAdvise