ICEnroll4::RequestStoreType property

[This property is no longer available for use as of Windows Server 2008 and Windows Vista.]

The RequestStoreType property sets or retrieves the type of store to use for the store specified by the RequestStoreName property. This store type is passed directly to the CertOpenStore function.

The default value of this property is sz_CERT_STORE_PROV_SYSTEM. If the default is not to be used, this property must be set to the same value before calls to createPKCS10/createFilePKCS10 and again before calls to acceptPKCS7/acceptFilePKCS7.

Only system stores are supported. This property was first defined in the ICEnroll interface.

This property is read/write.

Syntax


HRESULT put_RequestStoreType(
  [in]  BSTR Type
);

HRESULT get_RequestStoreType(
  [out] BSTR *pType
);

Property value

A string that contains the type of store to use for the store specified by the RequestStoreName property. The following table shows the possible values.

ValueMeaning
sz_CERT_STORE_PROV_SYSTEM_W

"System"

sz_CERT_STORE_PROV_SYSTEM

"System"

 

Error codes

If the property access methods put_RequestStoreType and get_RequestStoreType succeed, they return S_OK.

Any other HRESULT value indicates that the call failed.

Remarks

Typically, modification of the RequestStoreType property is performed only in advanced applications.

RequestStoreType affects the behavior of the following methods:

The ability to set this property is disabled when the Certificate Enrollment Control is executed as a scripted control.

Examples


BSTR     bstrStoreType = NULL;
HRESULT  hr;

// pEnroll is previously instantiated ICEnroll interface pointer

// get the storetype
hr = pEnroll->get_RequestStoreType( &bstrStoreType );
if ( FAILED ( hr ) )
    printf("Failed getting RequestStoreType - %x\n", hr );
else
    printf( "RequestStoreType: %ws\n", bstrStoreType );
// free BSTR when done
if ( NULL != bstrStoreType )
    SysFreeString( bstrStoreType );

// set the storetype
// bstrNewType is a BSTR that is previously set to a valid store type
hr = pEnroll->put_RequestStoreType( bstrNewType );
if ( FAILED ( hr ) )
    printf("Failed setting RequestStoreType - %x\n", hr );
else
    printf( "RequestStoreType was set to %ws\n", bstrNewType );

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

End of client support

Windows XP

End of server support

Windows Server 2003

Header

Xenroll.h

Library

Uuid.lib

DLL

Xenroll.dll

IID

IID_ICEnroll4 is defined as c1f1188a-2eb5-4a80-841b-7e729a356d90

 

 

Show: