Estructura PROPPAGEINFO (ocidl.h)

Contiene parámetros usados para describir una página de propiedades en un marco de propiedad. Una página de propiedades rellena una estructura proporcionada por el autor de la llamada en el método IPropertyPage::GetPageInfo .

Sintaxis

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

Miembros

cb

El tamaño de la estructura en bytes.

pszTitle

Puntero a un OLESTR que contiene la cadena que aparece en la pestaña de esta página. La cadena debe asignarse con CoTaskMemAlloc. El autor de la llamada de IPropertyPage::GetPageInfo es responsable de liberar la memoria con CoTaskMemFree.

size

Dimensiones necesarias del cuadro de diálogo de la página, en píxeles.

pszDocString

Puntero a una cadena de texto que describe la página, que se puede mostrar en el cuadro de diálogo hoja de propiedades (la implementación del marco actual no usa este campo). El texto debe asignarse con CoTaskMemAlloc. El autor de la llamada de IPropertyPage::GetPageInfo es responsable de liberar la memoria con CoTaskMemFree.

pszHelpFile

Puntero a un OLESTR que contiene el nombre simple del archivo de ayuda que describe esta página de propiedades usada en lugar de implementar IPropertyPage::Help. Cuando el usuario presiona ayuda, normalmente se llama al método Help. Si se produce un error en ese método, el marco abrirá el sistema de ayuda con este archivo de ayuda (con el prefijo del valor de la clave HelpDir en las entradas del Registro de la página de propiedades en su CLSID) e indicará al sistema de ayuda que muestre el contexto descrito por el campo dwHelpContext . La ruta de acceso debe asignarse con CoTaskMemAlloc. El autor de la llamada de IPropertyPage::GetPageInfo es responsable de liberar la memoria con CoTaskMemFree.

dwHelpContext

Identificador de contexto del tema de ayuda en pszHelpFile que describe esta página.

Comentarios

Los miembros pszTitle, pszDocString y pszHelpFile especificados en esta estructura deben contener texto confidencial a la configuración regional obtenida a través de IPropertyPageSite::GetLocaleID.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Encabezado	ocidl.h

Consulte también

IPropertyPage::GetPageInfo

IPropertyPageSite::GetLocaleID

OLESTR