Export (0) Print
Expand All

IOleInPlaceSite::Scroll method

Instructs the container to scroll the view of the object by the specified number of pixels.

Syntax


HRESULT Scroll(
  [in]  SIZE scrollExtant
);

Parameters

scrollExtant [in]

The number of pixels by which to scroll in the X and Y directions.

Return value

This method returns S_OK on success. Other possible return values include the following.

Return codeDescription
E_INVALIDARG

The specified pointer is not valid.

E_UNEXPECTED

An unexpected error has occurred.

 

Remarks

As a result of scrolling, the object's visible rectangle can change. If that happens, the container should give the new clipping rectangle to the object by calling IOleInPlaceObject::SetObjectRects. The intersection of the lprcClipRect and lprcPosRect rectangles gives the new visible rectangle. See IOleInPlaceSite::GetWindowContext for more information.

Notes to Callers

Called by an active, in-place object when it is asking the container to scroll.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

OleIdl.h

IDL

OleIdl.Idl

IID

IID_IOleInPlaceSite is defined as 00000119-0000-0000-C000-000000000046

See also

IOleInPlaceSite
IOleInPlaceObject::SetObjectRects

 

 

Community Additions

ADD
Show:
© 2014 Microsoft