PROPPAGEINFO 结构 (ocidl.h)

包含用于向属性框架描述属性页的参数。 属性页填充 IPropertyPage::GetPageInfo 方法中调用方提供的结构。

语法

typedef struct tagPROPPAGEINFO {
  ULONG    cb;
  LPOLESTR pszTitle;
  SIZE     size;
  LPOLESTR pszDocString;
  LPOLESTR pszHelpFile;
  DWORD    dwHelpContext;
} PROPPAGEINFO, *LPPROPPAGEINFO;

成员

cb

结构大小(以字节为单位)。

pszTitle

指向 OLESTR 的指针,该 OLESTR 包含此页的选项卡中显示的字符串。 必须使用 CoTaskMemAlloc 分配字符串。 IPropertyPage::GetPageInfo 的调用方负责使用 CoTaskMemFree 释放内存。

size

页面对话框的所需尺寸(以像素为单位)。

pszDocString

指向描述页面的文本字符串的指针,该字符串可以在属性表对话框中显示, (当前框架实现不使用此字段) 。 必须使用 CoTaskMemAlloc 分配文本。 IPropertyPage::GetPageInfo 的调用方负责使用 CoTaskMemFree 释放内存。

pszHelpFile

指向包含帮助文件的简单名称的 OLESTR 的指针,该文件描述使用的此属性页,而不是实现 IPropertyPage::Help。 当用户按 Help 时,通常会调用 Help 方法。 如果该方法失败,框架将打开帮助系统,此帮助文件 (属性页的注册表项中其 CLSID) 下的 HelpDir 键值作为前缀,并指示帮助系统显示 dwHelpContext 字段描述的上下文。 必须使用 CoTaskMemAlloc 分配路径。 IPropertyPage::GetPageInfo 的调用方负责使用 CoTaskMemFree 释放内存。

dwHelpContext

pszHelpFile 中描述此页面的帮助主题的上下文标识符。

注解

此结构中指定的 pszTitlepszDocStringpszHelpFile 成员应包含对通过 IPropertyPageSite::GetLocaleID 获取的区域设置敏感的文本。

要求

要求
最低受支持的客户端 Windows 2000 Professional [仅限桌面应用]
最低受支持的服务器 Windows 2000 Server [仅限桌面应用]
标头 ocidl.h

另请参阅

IPropertyPage::GetPageInfo

IPropertyPageSite::GetLocaleID

OLESTR