WriteCertToUserDS Property

ICEnroll4::WriteCertToUserDS property

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

The WriteCertToUserDS property sets or retrieves a Boolean value that determines whether the certificate is written to the user's Active Directory store.

This property should not need to be modified by most applications. This property was first defined in the ICEnroll2 interface.

This property is read/write.

Syntax


HRESULT put_WriteCertToUserDS(
  [in]  BOOL bValue
);

HRESULT get_WriteCertToUserDS(
  [out] BOOL *pbValue
);

Property value

If true, the certificate is written to the user's Active Directory store.

Error codes

If the property access methods put_WriteCertToUserDS and get_WriteCertToUserDS succeed, they return S_OK.

Any other HRESULT value indicates that the call failed.

Remarks

WriteCertToUserDS 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


BOOL     bWriteUserDS;
HRESULT  hr;

// pEnroll is previously instantiated ICEnroll2 interface pointer

// get the WriteCertToUserDS value
hr = pEnroll->get_WriteCertToUserDS( &bWriteUserDS );
if (FAILED( hr ))
    printf("Failed get_WriteCertToUserDS - %x\n", hr );
else
    printf( "WriteCertToUserDS: %d\n", bWriteUserDS );

// set the WriteCertToUserDS value
hr = pEnroll->put_WriteCertToUserDS( TRUE );
if (FAILED( hr ))
    printf("Failed put_WriteCertToUserDS - %x\n", hr );
else
    printf( "WriteCertToUserDS set to TRUE\n" );

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:
© 2016 Microsoft