READERMODEINFO structure

[READERMODEINFO is supported through Windows XP with Service Pack 2 (SP2). It might be unsupported in subsequent versions.]

Contains information required to initialize the DoReaderMode function.

Syntax

typedef struct tagReaderModeInfo {
  UINT                       cbSize;
  HWND                       hwnd;
  DWORD                      fFlags;
  LPRECT                     prc;
  PFNREADERSCROLL            pfnScroll;
  PFNREADERTRANSLATEDISPATCH fFlags;
  LPARAM                     lParam;
} READERMODEINFO, *PREADERMODEINFO;

Members

cbSize

Type: UINT

Required. The size of the structure, in bytes. Set this parameter to sizeof(READERMODE) before you call DoReaderMode.

hwnd

Type: HWND

Required. The handle of the window to be used for reader mode.

fFlags

Type: DWORD

Flags customizing the functionality of the reader mode window. This parameter can be 0; otherwise, one or more of the following values.

Value	Meaning
RMF_ZEROCURSOR 0x01	Sets the cursor in the center of the area specified in prc. If this flag is not specified, the cursor position remains unchanged.
RMF_VERTICALONLY 0x02	Allows only vertical scrolling.
RMF_HORIZONTALONLY 0x04	Allows only horizontal scrolling.

prc

Type: LPRECT

A pointer to a RECT structure that specifies the scrolling area in the reader mode window. If this member is NULL, then the entire window is used as the scrolling area.

pfnScroll

Type: PFNREADERSCROLL

A pointer to an application-defined ReaderScroll callback function used to notify the application that the window needs to be scrolled in a particular direction.

fFlags

Type: PFNREADERTRANSLATEDISPATCH

A pointer to an application-defined TranslateDispatch callback function used to get first notification of any messages sent to the reader mode window.

lParam

Type: LPARAM

Additional information as needed by the application, read by the caller in the ReaderScroll callback function.

Remarks

This structure is not declared in any public header. To use it, you must include the declaration shown above in your own header.

Requirements

Requirement	Value
Minimum supported client	Windows Vista, Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]