Compartilhar via


Estrutura PROPPAGEINFO (ocidl.h)

Contém parâmetros usados para descrever uma página de propriedades para um quadro de propriedades. Uma página de propriedades preenche uma estrutura fornecida pelo chamador no método IPropertyPage::GetPageInfo .

Sintaxe

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

Membros

cb

O tamanho da estrutura em bytes.

pszTitle

Ponteiro para um OLESTR que contém a cadeia de caracteres que aparece na guia desta página. A cadeia de caracteres deve ser alocada com CoTaskMemAlloc. O chamador de IPropertyPage::GetPageInfo é responsável por liberar a memória com CoTaskMemFree.

size

Dimensões necessárias da caixa de diálogo da página, em pixels.

pszDocString

Ponteiro para uma cadeia de caracteres de texto que descreve a página, que pode ser exibida na caixa de diálogo da folha de propriedades (a implementação do quadro atual não usa esse campo). O texto deve ser alocado com CoTaskMemAlloc. O chamador de IPropertyPage::GetPageInfo é responsável por liberar a memória com CoTaskMemFree.

pszHelpFile

Ponteiro para um OLESTR que contém o nome simples do arquivo de ajuda que descreve essa página de propriedades usada em vez de implementar IPropertyPage::Help. Quando o usuário pressiona a Ajuda, o método Ajuda normalmente é chamado. Se esse método falhar, o quadro abrirá o sistema de ajuda com esse arquivo de ajuda (prefixado com o valor da chave HelpDir nas entradas do registro da página de propriedades em seu CLSID) e instruirá o sistema de ajuda a exibir o contexto descrito pelo campo dwHelpContext . O caminho deve ser alocado com CoTaskMemAlloc. O chamador de IPropertyPage::GetPageInfo é responsável por liberar a memória com CoTaskMemFree.

dwHelpContext

Identificador de contexto para o tópico de ajuda no pszHelpFile que descreve esta página.

Comentários

Os membros pszTitle, pszDocString e pszHelpFile especificados nessa estrutura devem conter texto sensível à localidade obtida por meio de IPropertyPageSite::GetLocaleID.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows 2000 Server [somente aplicativos da área de trabalho]
Cabeçalho ocidl.h

Confira também

IPropertyPage::GetPageInfo

IPropertyPageSite::GetLocaleID

OLESTR