Método ICertRequest::GetCACertificate (certcli.h)

Artigo
08/22/2023

O método GetCACertificate retorna o certificado de autoridade de certificação (CA) para o servidor dos Serviços de Certificados.

Sintaxe

HRESULT GetCACertificate(
  [in]          LONG       fExchangeCertificate,
  [in]          const BSTR strConfig,
  [in]          LONG       Flags,
  [out, retval] BSTR       *pstrCertificate
);

Parâmetros

[in] fExchangeCertificate

Um valor booliano que especifica qual certificado de AC retornar. Se fExchangeCertificate estiver definido como false, o certificado de assinatura da AC será retornado. O certificado de assinatura da AC pode ser usado para verificar assinaturas em certificados emitidos pela AC.

Windows Server 2003: Se fExchangeCertificate estiver definido como true, o certificado do Exchange da AC será retornado. O certificado do Exchange da AC pode ser usado para criptografar solicitações enviadas à AC.

A partir do Windows 7 e do Windows Server 2008 R2, esse parâmetro é ignorado durante https:// registro e a função, se bem-sucedida, sempre retorna o certificado de troca de autoridade de certificação. Para recuperar o certificado de autenticação de AUTORIDADE para um serviço Web de registro, use o método Property na interface ICertificationAuthority com o valor de enumeração CAPropCertificate EnrollmentCAProperty .

Observe que TRUE é definido (em um arquivo de cabeçalho da Microsoft) para programadores C/C++ como um, enquanto o Visual Basic define o True palavra-chave como negativo. Como resultado, os desenvolvedores do Visual Basic devem usar um (em vez de True) para definir esse parâmetro como TRUE. No entanto, para definir esse parâmetro como FALSE, os desenvolvedores do Visual Basic podem usar zero ou False.

[in] strConfig

Representa uma cadeia de caracteres de configuração válida para o servidor dos Serviços de Certificados. A cadeia de caracteres pode ser uma URL HTTPS para um servidor de registro ou no formulário ComputerName\CAName, em que ComputerName é o nome de rede do servidor e CAName é o nome comum da autoridade de certificação, conforme inserido durante a instalação dos Serviços de Certificado. Para obter informações sobre o nome da cadeia de caracteres de configuração, consulte ICertConfig.

Windows Server 2008, Windows Vista, Windows Server 2003 e Windows XP: Não há suporte para uma URL HTTPS como entrada.

[in] Flags

Os sinalizadores a seguir podem ser usados para especificar o formato do certificado retornado.

Valor	Significado
CR_OUT_BASE64HEADER	Formato BASE64 com início/término.
CR_OUT_BASE64	Formato BASE64 sem início/término.
CR_OUT_BINARY	Formato binário.

O sinalizador a seguir pode ser combinado com o sinalizador de formato para especificar que a cadeia de certificados completa deve ser incluída com o certificado de autoridade de certificação solicitado. Caso contrário, apenas o certificado de autoridade de certificação solicitado (no formato X.509 ) será retornado.

Valor	Significado
CR_OUT_CHAIN	Inclua a cadeia de certificados completa em um PKCS nº 7.

[out, retval] pstrCertificate

Um ponteiro para o BSTR que contém o certificado de AC para o servidor de Serviços de Certificados, no formato especificado.

Valor retornado

C++

Se o método for bem-sucedido, o método retornará S_OK.

Após a conclusão bem-sucedida desse método, *pstrCertificate é definido como o BSTR que contém o certificado de AC. Para usar esse método, crie uma variável do tipo BSTR , defina a variável igual a NULL e passe o endereço dessa variável como pstrCertificate.

Quando terminar de usar *pstrCertificate, libere-o chamando a função SysFreeString .

Se o método falhar, ele retornará um valor HRESULT que indica o erro. Para obter uma lista de códigos de erro comuns, consulte Valores HRESULT comuns.

VB

O certificado de autoridade de certificação para o servidor dos Serviços de Certificados, no formato especificado.

Comentários

As tarefas de administração usam o DCOM. O código que chama esse método de interface conforme definido em uma versão anterior do Certadm.h será executado em servidores baseados no Windows, desde que o cliente e o servidor estejam executando o mesmo sistema operacional Windows.

Requisitos


Cliente mínimo com suporte	Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	certcli.h (inclua Certsrv.h)
Biblioteca	Certidl.lib
DLL	Certcli.dll