Metode ICertServerPolicy::GetRequestProperty (certif.h)

Artikel
02/26/2024

Metode GetRequestProperty mengambil properti tertentu dari permintaan.

Sintaks

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

Parameter

[in] strPropertyName

Menentukan nama properti yang akan diambil. Parameter ini dapat diatur ke properti nama atau properti permintaan.

Properti nama mencakup sekumpulan properti sertifikat yang selalu valid dan dapat diambil dengan memanggil metode ini. Untuk informasi tentang properti ini, lihat Properti Nama.

Properti permintaan unik untuk permintaan dan menyertakan nilai yang mungkin berikut.

Nilai	Makna
RequestID Ditandatangani panjang	RequestID internal.
RawRequest Biner	Byte permintaan mentah.
RequestAttributes String	String atribut (dapat dipotok).
RequestType Ditandatangani panjang	Menunjukkan permintaan PKCS #10 atau KeyGen. Untuk informasi selengkapnya tentang properti ini, lihat Keterangan.
DiserahkanSaat itu Tanggal/Waktu	Ketika tiba.
RequesterName String	Nama pemohon dalam formulir "DomainName\UserID".

Catatan Ada properti permintaan tambahan yang tidak dapat diakses oleh GetRequestProperty karena tidak diatur sampai setelah modul kebijakan selesai memproses permintaan. Selain itu, properti lain dapat diatur oleh jenis permintaan tertentu, ekstensi permintaan, atau oleh atribut bernama yang diatur di header permintaan.

[in] PropertyType

Menentukan jenis properti. Parameter PropertyType bisa menjadi salah satu jenis berikut.

Nilai	Makna
PROPTYPE_LONG	Data panjang yang ditandatangani.
PROPTYPE_DATE	Tanggal/waktu.
PROPTYPE_BINARY	Data biner.
PROPTYPE_STRING	Data string Unicode .

[out] pvarPropertyValue

Penunjuk ke VARIAN yang berisi jenis properti permintaan.

Nilai kembali

C++

Jika metode berhasil, metode mengembalikan S_OK, dan parameter pvarPropertyValue berisi properti permintaan.

Jika metode gagal, metode mengembalikan nilai HRESULT yang menunjukkan kesalahan. Untuk daftar kode kesalahan umum, lihat Nilai HRESULT Umum.

VB

Nilai yang dikembalikan adalah properti permintaan.

Keterangan

Metode SetContext harus dipanggil sebelum memanggil metode ini. Panggilan ke SetContext menentukan permintaan mana yang digunakan sebagai konteks saat ini.

Permintaan menyimpan semua status terkait untuk permintaan dan sertifikat yang akhirnya diberikan yang bukan bagian dari sertifikat. Dengan demikian, data seperti waktu pencabutan dan data disposisi disimpan di objek data permintaan.

Properti RequestType dapat diatur ke salah satu nilai berikut.

Nilai	Makna
CR_IN_PKCS	Permintaan ini adalah permintaan perpanjangan atau pendaftaran PKCS #7.
CR_IN-PKCS10	Permintaannya adalah permintaan PKCS #10.
CR_IN_KEYGEN	Permintaannya adalah permintaan Keygen (format Netscape).

Contoh

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 );

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Tidak ada yang didukung
Server minimum yang didukung	Windows Server 2003 [hanya aplikasi desktop]
Target Platform	Windows
Header	certif.h (termasuk Certsrv.h)
Pustaka	Certidl.lib
DLL	Certcli.dll