The GetFullResponseProperty method retrieves the cached response data returned by the server.
Syntax
HRESULT GetFullResponseProperty(
[in] LONG PropId,
[in] LONG PropIndex,
[in] LONG PropType,
[in] LONG Flags,
[out] VARIANT *pvarPropertyValue
);
Parameters
- PropId [in]
-
The data to be retrieved. If the property is indexed, use PropIndex to specify the index.
This parameter can be one of the following values.
| Value | Meaning |
|---|
- FR_PROP_NONE
- 0
|
No data.
|
- FR_PROP_FULLRESPONSE
- 1
|
All the cached data is retrieved (binary data).
|
- FR_PROP_STATUSINFOCOUNT
- 2
|
The number of responses in cache data (long, indexed property).
|
- FR_PROP_BODYPARTSTRING
- 3
|
Hierarchy data (string, indexed property).
|
- FR_PROP_STATUS
- 4
|
The request status value (long, indexed property).
|
- FR_PROP_STATUSSTRING
- 5
|
The request status string (string, indexed property).
|
- FR_PROP_OTHERINFOCHOICE
- 6
|
Choice for other information (long, indexed property). This can be one of the following values.
- CMC_OTHER_INFO_NO_CHOICE
- CMC_OTHER_INFO_FAIL_CHOICE
- CMC_OTHER_INFO_PEND_CHOICE
|
- FR_PROP_FAILINFO
- 7
|
The request failure information (long, indexed property).
|
- FR_PROP_PENDINFOTOKEN
- 8
|
The request pending token (binary, indexed property).
|
- FR_PROP_PENDINFOTIME
- 9
|
The request pending date (DATE, indexed property).
|
- FR_PROP_ISSUEDCERTIFICATEHASH
- 10
|
The hash of the issued certificate is retrieved (binary, indexed property).
|
- FR_PROP_ISSUEDCERTIFICATE
- 11
|
The issued certificate is retrieved (binary, indexed property).
|
- FR_PROP_ISSUEDCERTIFICATECHAIN
- 12
|
The issued certificate (binary, indexed property).
|
- FR_PROP_ISSUEDCERTIFICATECRLCHAIN
- 13
|
The issued certificate chain (binary, indexed property).
|
- FR_PROP_ENCRYPTEDKYEHASH
- 14
|
The encrypted key hash (binary, indexed property).
|
- FR_PROP_FULLRESPONSENOPKCS7
- 15
|
All the cached data is retrieved except for the PKCS #7 (binary).
|
- PropIndex [in]
-
The zero-based index when PropId is an indexed property. If PropId is not an indexed property, then PropIndex must be zero.
- PropType [in]
-
The type of data returned in pvarPropertyValue. The property type here must match the type of data specified by the PropId parameter.
This parameter can be one of the following values.
| Value | Meaning |
|---|
- PROPTYPE_LONG
- 1
|
Signed long data.
|
- PROPTYPE_DATE
- 2
|
Date data (includes date and time).
|
- PROPTYPE_BINARY
- 3
|
Binary data.
|
- PROPTYPE_STRING
- 4
|
String data.
|
- Flags [in]
-
The format of the data returned in pvarPropertyValue. The flag set here must match the type of data specified by the PropId parameter.
For more information, see Remarks.
This parameter can be one of the following values.
| Value | Meaning |
|---|
- CR_OUT_BASE64HEADER
- 0
|
BASE64 format with begin/end header.
|
- CR_OUT_BASE64
- 1
|
BASE64 format without begin/end header.
|
- CR_OUT_BINARY
- 2
|
Binary format.
|
- pvarPropertyValue [out]
-
The data returned.
Return Value
If the method succeeds, the method returns S_OK and pvarPropertyValue contains the returned data.If the method fails, it returns an HRESULT value that indicates the error. For a list of common error codes, see Common HRESULT Values.
Function GetFullResponseProperty( _
ByVal PropId, _
ByVal PropIndex, _
ByVal PropType, _
ByVal Flags _
)
Parameters
- PropId [in]
-
The data to be retrieved. If the property is indexed, use PropIndex to specify the index.
This parameter can be one of the following values.
| Value | Meaning |
|---|
- FR_PROP_NONE
- 0
|
No data.
|
- FR_PROP_FULLRESPONSE
- 1
|
All the cached data is retrieved (binary data).
|
- FR_PROP_STATUSINFOCOUNT
- 2
|
The number of responses in cache data (long, indexed property).
|
- FR_PROP_BODYPARTSTRING
- 3
|
Hierarchy data (string, indexed property).
|
- FR_PROP_STATUS
- 4
|
The request status value (long, indexed property).
|
- FR_PROP_STATUSSTRING
- 5
|
The request status string (string, indexed property).
|
- FR_PROP_OTHERINFOCHOICE
- 6
|
Choice for other information (long, indexed property). This can be one of the following values.
- CMC_OTHER_INFO_NO_CHOICE
- CMC_OTHER_INFO_FAIL_CHOICE
- CMC_OTHER_INFO_PEND_CHOICE
|
- FR_PROP_FAILINFO
- 7
|
The request failure information (long, indexed property).
|
- FR_PROP_PENDINFOTOKEN
- 8
|
The request pending token (binary, indexed property).
|
- FR_PROP_PENDINFOTIME
- 9
|
The request pending date (DATE, indexed property).
|
- FR_PROP_ISSUEDCERTIFICATEHASH
- 10
|
The hash of the issued certificate is retrieved (binary, indexed property).
|
- FR_PROP_ISSUEDCERTIFICATE
- 11
|
The issued certificate is retrieved (binary, indexed property).
|
- FR_PROP_ISSUEDCERTIFICATECHAIN
- 12
|
The issued certificate (binary, indexed property).
|
- FR_PROP_ISSUEDCERTIFICATECRLCHAIN
- 13
|
The issued certificate chain (binary, indexed property).
|
- FR_PROP_ENCRYPTEDKYEHASH
- 14
|
The encrypted key hash (binary, indexed property).
|
- FR_PROP_FULLRESPONSENOPKCS7
- 15
|
All the cached data is retrieved except for the PKCS #7 (binary).
|
- PropIndex [in]
-
The zero-based index when PropId is an indexed property. If PropId is not an indexed property, then PropIndex must be zero.
- PropType [in]
-
The type of data returned in pvarPropertyValue. The property type here must match the type of data specified by the PropId parameter.
This parameter can be one of the following values.
| Value | Meaning |
|---|
- PROPTYPE_LONG
- 1
|
Signed long data.
|
- PROPTYPE_DATE
- 2
|
Date data (includes date and time).
|
- PROPTYPE_BINARY
- 3
|
Binary data.
|
- PROPTYPE_STRING
- 4
|
String data.
|
- Flags [in]
-
The format of the data returned in pvarPropertyValue. The flag set here must match the type of data specified by the PropId parameter.
For more information, see Remarks.
This parameter can be one of the following values.
| Value | Meaning |
|---|
- CR_OUT_BASE64HEADER
- 0
|
BASE64 format with begin/end header.
|
- CR_OUT_BASE64
- 1
|
BASE64 format without begin/end header.
|
- CR_OUT_BINARY
- 2
|
Binary format.
|
Return Value
The return value is a Variant that contains the returned data.
Remarks
The following PropId values return binary data, which means that the Flags parameter must set to CR_OUT_BINARY:
- FR_PROP_FULLRESPONSE
- FR_PROP_ISSUEDCERTIFICATEHASH
- FR_PROP_ISSUEDCERTIFICATE
- FR_PROP_ISSUEDCERTIFICATECHAIN
- FR_PROP_ISSUEDCERTIFICATECRLCHAIN
- FR_PROP_ENCRYPTEDKYEHASH
- FR_PROP_FULLRESPONSENOPKCS7
This method is called after the ICertRequest3::Submit or ICertRequest3::RetrievePending methods have been called. These methods populate the cached data that is returned by GetFullResponseProperty.
After the ICertRequest3::GetFullResponseProperty method returns its data, the following methods can be called:
Requirements
| Minimum supported client | Windows XP |
|---|
| Minimum supported server | Windows Server 2003 |
|---|
| Header | Certcli.h (include Certsrv.h) |
|---|
| Library | Certidl.lib |
|---|
| DLL | Certcli.dll |
|---|
| IID | IID_ICertRequest3 is defined as AFC8F92B-33A2-4861-BF36-2933B7CD67B3 |
|---|
See Also
- ICertRequest3
- ICertRequest2
- ICertRequest
- CCertRequest
Send comments about this topic to Microsoft
Build date: 11/16/2009