Méthode ICertServerPolicy ::GetRequestProperty (certif.h)

Article
08/22/2023

La méthode GetRequestProperty récupère une propriété spécifique à partir d’une requête.

Syntaxe

HRESULT GetRequestProperty(
  [in]  const BSTR strPropertyName,
  [in]  LONG       PropertyType,
  [out] VARIANT    *pvarPropertyValue
);

Paramètres

[in] strPropertyName

Spécifie le nom de la propriété à récupérer. Ce paramètre peut être défini sur une propriété name ou une propriété de requête.

Les propriétés de nom incluent un ensemble stock de propriétés de certificat qui sont toujours valides et peuvent être récupérées en appelant cette méthode. Pour plus d’informations sur ces propriétés, consultez Propriétés du nom.

Les propriétés de requête sont propres aux requêtes et incluent les valeurs possibles suivantes.

Valeur	Signification
RequestID Signé long	RequestID interne.
RawRequest Binary	Octets de requête bruts.
RequestAttributes String	Chaîne d’attribut (peut être tronquée).
RequestType Signé long	Indique une requête PKCS #10 ou KeyGen. Pour plus d’informations sur cette propriété, consultez Remarques.
SubmittedWhen Date/heure	Quand est arrivé.
RequesterName String	Nom du demandeur sous la forme « DomainName\UserID ».

Note Il existe des propriétés de requête supplémentaires qui ne sont pas accessibles par GetRequestProperty , car elles ne sont définies qu’une fois que le module de stratégie a terminé le traitement de la demande. En outre, d’autres propriétés peuvent être définies par un type de requête spécifique, des extensions de demande ou par des attributs nommés définis dans l’en-tête d’une requête.

[in] PropertyType

Spécifie le type de propriété. Le paramètre PropertyType peut être l’un des types suivants.

Valeur	Signification
PROPTYPE_LONG	Données longues signées.
PROPTYPE_DATE	Date/heure.
PROPTYPE_BINARY	Données binaires.
PROPTYPE_STRING	Données de chaîne Unicode.

[out] pvarPropertyValue

Pointeur vers le variant qui contient le type de propriété de requête.

Valeur retournée

C++

Si la méthode réussit, la méthode retourne S_OK et le paramètre pvarPropertyValue contient la propriété request.

Si la méthode échoue, elle retourne une valeur HRESULT qui indique l’erreur. Pour obtenir la liste des codes d’erreur courants, consultez Valeurs HRESULT courantes.

VB

La valeur de retour est la propriété de requête.

Remarques

La méthode SetContext doit être appelée avant d’appeler cette méthode. L’appel à SetContext spécifie quelle requête est utilisée comme contexte actuel.

Les demandes contiennent tous les états associés pour la demande et le certificat éventuellement accordé qui ne fait pas partie du certificat. Ainsi, les données telles que les temps de révocation et les données de destruction sont conservées dans l’objet de données de demande.

La propriété RequestType peut être définie sur l’une des valeurs suivantes.

Valeur	Signification
CR_IN_PKCS	La demande est une demande de renouvellement ou d’inscription PKCS #7.
CR_IN-PKCS10	La requête est une requête PKCS #10.
CR_IN_KEYGEN	La requête est une requête Keygen (format Netscape).

Exemples

BSTR      bstrPropName = NULL;
VARIANT   varProp;

VariantInit( &varProp );

bstrPropName = SysAllocString(L"RequestID");

// Retrieve the request property.
// pCertServerPolicy has been used to call SetContext previously.
hr = pCertServerPolicy->GetRequestProperty( bstrPropName,
                                          PROPTYPE_LONG,
                                          &varProp );
if (FAILED(hr))
{
    printf("Failed GetRequestProperty [%x]\n", hr);
    goto error;
}
else
{
    // Successfully retrieved property; use varProp as needed.
    // ...
}

// Done processing.
VariantClear( &varProp );
if ( NULL != bstrPropName )
    SysFreeString( bstrPropName );

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Aucun pris en charge
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	certif.h (include Certsrv.h)
Bibliothèque	Certidl.lib
DLL	Certcli.dll