ICEnroll4::ClientID property

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

The ClientId property sets or retrieves a client ID request attribute. The client ID request attribute indicates the source of the certificate request. This property was first defined in the ICEnroll4 interface.

This property is read/write.

Syntax


HRESULT put_ClientID(
  [in]  LONG lClientID
);

HRESULT get_ClientID(
  [out] LONG *plClientId
);

Property value

A Long value that specifies the client ID request attribute. This can be one of the following values.

ValueMeaning
XECI_DISABLE
0

No client ID request attribute is set.

XECI_XENROLL
1

The certificate request attribute is for the Certificate Enrollment control. This is the default value.

XECI_AUTOENROLL
2

The certificate request attribute is for auto-enrollment.

XECI_REQWIZARD
3

The certificate request attribute is for the Certificate Request Wizard.

XECI_CERTREQ
4

The certificate request attribute is for the Certreq command-line tool.

 

Error codes

If the property access methods get_ClientId and put_ClientId succeed, the return value is S_OK.

Any other HRESULT value indicates that the call failed.

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

See also

ICEnroll4

 

 

Show: