Export (0) Print
Expand All

ICEnroll4::RequestStoreName property

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

The RequestStoreName property sets or retrieves the name of the store that contains the dummy certificate. This dummy certificate, along with the added private keys, remains in the request store until a certification authority processes the request and responds with a PKCS #7.

The default value for this property is "REQUEST". If the default is not to be used, this property must be set to the store to be used before calls to createPKCS10 or createFilePKCS10 and again before calls to acceptPKCS7 or acceptFilePKCS7.

This property was first defined in the ICEnroll interface.

This property is read/write.

Syntax


HRESULT put_RequestStoreName(
  [in]   BSTR Name
);

HRESULT get_RequestStoreName(
  [out]  BSTR *pName
);

Property value

A string that contains the name of the store that contains the dummy certificate. The string can be any defined store name. The following list shows some possible values. The default value is "REQUEST".

  • "REQUEST"
  • "ROOT"
  • "CA"
  • "MY"

Error codes

If the property access methods put_RequestStoreName and get_RequestStoreName succeed, they return S_OK.

Any other HRESULT value indicates that the call failed.

Remarks

Typically, modification of the RequestStoreName property is performed only in advanced applications. Changing this value is not recommended for most applications.

The RequestStoreName property 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     bstrStoreName = NULL;
HRESULT  hr;

// pEnroll is previously instantiated ICEnroll interface pointer

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

// set the storename
// bstrNewName is a BSTR that is previously set to a valid store name
hr = pEnroll->put_RequestStoreName( bstrNewName );
if ( FAILED ( hr ) )
    printf("Failed setting RequestStoreName - %x\n", hr );
else
    printf( "RequestStoreName was set to : %ws\n", bstrNewName );

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

 

 

Community Additions

ADD
Show:
© 2014 Microsoft