Função SHOpenPropSheetA (shlobj.h)

Artigo
11/20/2024

[ SHOpenPropSheet está disponível para uso nos sistemas operacionais especificados na seção Requisitos. Ele pode estar alterado ou indisponível em versões subsequentes.]

Cria uma folha de propriedades de uma lista de chaves do Registro que contêm o CLSIDdas planilhas individuais e, em seguida, abre a folha de propriedades.

Sintaxe

BOOL SHOpenPropSheetA(
  [in, optional] LPCSTR        pszCaption,
  [in, optional] HKEY []       ahkeys,
                 UINT          ckeys,
  [in, optional] const CLSID   *pclsidDefault,
  [in]           IDataObject   *pdtobj,
  [in, optional] IShellBrowser *psb,
  [in, optional] LPCSTR        pStartPage
);

Parâmetros

[in, optional] pszCaption

Tipo: LPCTSTR

Um ponteiro para uma cadeia de caracteres que contém a legenda da folha de propriedades. Esse valor poderá ser NULL se nenhuma legenda for necessária.

[in, optional] ahkeys

Tipo: HKEY[]

Uma matriz de chaves do Registro que representam o CLSIDdas folhas de propriedades individuais.

ckeys

Tipo: UINT

valor UINT que especifica o número de folhas de propriedades na matriz especificada por ahkeys.

[in, optional] pclsidDefault

Tipo: const CLSID*

Um ponteiro para oCLSID padrão. Esse valor pode ser NULL.

[in] pdtobj

Tipo: * IDataObject

Um ponteiro para um IDataObject, um objeto OLE que pode ser usado para executar ações nas folhas de propriedades.

[in, optional] psb

Tipo: * IShellBrowser

Não usado.

[in, optional] pStartPage

Tipo: LPCTSTR

Um ponteiro para uma cadeia de caracteres que especifica a página inicial. Esse valor pode ser NULL.

Valor de retorno

Tipo: BOOL

Retorna VERDADEIRO se a folha de propriedades foi criada com êxito; caso contrário, FALSE .

Observações

Nota

O cabeçalho shlobj.h define SHOpenPropSheet como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows XP [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows Server 2003 [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	shlobj.h
biblioteca	Shell32.lib
de DLL	Shell32.dll (versão 5.0 ou posterior)

Compartilhar via