Compartilhar via

Método IPropertyPage::Help (ocidl.h)

  • Artigo

Invoca a ajuda da página de propriedades em resposta a uma solicitação do usuário final.

Sintaxe

HRESULT Help(
  [in] LPCOLESTR pszHelpDir
);

Parâmetros

[in] pszHelpDir

Um ponteiro para a cadeia de caracteres sob a chave HelpDir nas informações CLSID da página de propriedades no registro. Se HelpDir não existir, esse será o caminho encontrado na entrada InprocServer32 menos o nome do arquivo do servidor. (Observe que LocalServer32 não está marcado, pois não há suporte para páginas de propriedades locais).

Retornar valor

Esse método pode retornar os valores de retorno padrão E_OUTOFMEMORY e E_UNEXPECTED, bem como os valores a seguir.

Código de retorno Descrição
S_OK
 A página exibiu sua própria ajuda.
E_NOTIMPL
 A ajuda não é fornecida ou é fornecida apenas por meio das informações é PROPPAGEINFO.

Comentários

Anotações para chamadores

As chamadas para esse método devem ocorrer entre chamadas para IPropertyPage::Activate e IPropertyPage::D eactivate.

Anotações aos implementadores

Se a página falhar nesse método (como E_NOTIMPL), o quadro tentará usar os membros pszHelpFile e dwHelpContext da estrutura PROPPAGEINFO obtida por meio de IPropertyPage::GetPageInfo. Portanto, a página deve implementar IPropertyPage::Help ou retornar informações de ajuda por meio de IPropertyPage::GetPageInfo.

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]
Plataforma de Destino Windows
Cabeçalho ocidl.h

Confira também

Ipropertypage

PROPPAGEINFO