Skip to content

Commit 7fc249d

Browse files
committed
Merged PR 20901: Update InitializeEncode formatting and URLs
Update IX509AttributeClientId.InitializeEncode formatting and URLs.
1 parent 8a9efc2 commit 7fc249d

File tree

1 file changed

+19
-26
lines changed

1 file changed

+19
-26
lines changed

sdk-api-src/content/certenroll/nf-certenroll-ix509attributeclientid-initializeencode.md

Lines changed: 19 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ helpviewer_keywords: ["IX509AttributeClientId interface [Security]","InitializeE
66
old-location: security\ix509attributeclientid_initializeencode_method.htm
77
tech.root: security
88
ms.assetid: 6a0e5b6f-0522-4c60-9ea1-7a5c2722cebd
9-
ms.date: 12/05/2018
9+
ms.date: 11/27/2023
1010
ms.keywords: IX509AttributeClientId interface [Security],InitializeEncode method, IX509AttributeClientId.InitializeEncode, IX509AttributeClientId::InitializeEncode, InitializeEncode, InitializeEncode method [Security], InitializeEncode method [Security],IX509AttributeClientId interface, certenroll/IX509AttributeClientId::InitializeEncode, security.ix509attributeclientid_initializeencode_method
1111
req.header: certenroll.h
1212
req.include-header:
@@ -47,54 +47,47 @@ api_name:
4747

4848
# IX509AttributeClientId::InitializeEncode
4949

50-
5150
## -description
5251

53-
The <b>InitializeEncode</b> method initializes the attribute from information about the user, client computer, and application that submitted the <a href="/windows/desktop/SecGloss/c-gly">certificate request</a>.
52+
The **InitializeEncode** method initializes the attribute from information about the user, client computer, and application that submitted the [certificate request](/windows/win32/SecGloss/c-gly).
5453

5554
## -parameters
5655

5756
### -param ClientId [in]
5857

59-
A <a href="/windows/desktop/api/certenroll/ne-certenroll-requestclientinfoclientid">RequestClientInfoClientId</a> enumeration value that identifies the type of application that created the request. Examples include autoenrollment services, command-line request tools, and custom request applications.
58+
A [RequestClientInfoClientId](/windows/win32/api/certenroll/ne-certenroll-requestclientinfoclientid) enumeration value that identifies the type of application that created the request. Examples include auto-enrollment services, command-line request tools, and custom request applications.
6059

6160
### -param strMachineDnsName [in, optional]
6261

63-
A <b>BSTR</b> variable that contains the Domain Name System (DNS) name of the computer on which the request was created, for example <i>ComputerName.contoso.com</i>. If you do not supply a name, the method calls the <a href="/windows/desktop/api/sysinfoapi/nf-sysinfoapi-getcomputernameexa">GetComputerNameEx</a> function. If a name cannot be found, the method fails.
62+
A **BSTR** variable that contains the Domain Name System (DNS) name of the computer on which the request was created, for example `ComputerName.contoso.com`. If you do not supply a name, the method calls the [GetComputerNameEx](/windows/win32/api/sysinfoapi/nf-sysinfoapi-getcomputernameexa) function. If a name cannot be found, the method fails.
6463

6564
### -param strUserSamName [in, optional]
6665

67-
A <b>BSTR</b> variable that contains the <a href="/windows/desktop/SecGloss/s-gly">Security Accounts Manager</a> (SAM) name for the user in the form <i>DomainName\UserName</i>. If you do not supply a name, the method calls the <a href="/windows/desktop/api/secext/nf-secext-getusernameexa">GetUserNameEx</a> function. If a name cannot be found, the method fails.
66+
A **BSTR** variable that contains the [Security Accounts Manager](/windows/win32/SecGloss/s-gly) (SAM) name for the user in the form *DomainName\UserName*. If you do not supply a name, the method calls the [GetUserNameEx](/windows/win32/api/secext/nf-secext-getusernameexa) function. If a name cannot be found, the method fails.
6867

6968
### -param strProcessName [in, optional]
7069

71-
A <b>BSTR</b> variable that contains the name of the application that created the certificate request. If you do not supply a name, the method calls the <a href="/windows/desktop/api/processenv/nf-processenv-getcommandlinea">GetCommandLine()</a> function and parses the command line. If a name cannot be found, the method fails.
70+
A **BSTR** variable that contains the name of the application that created the certificate request. If you do not supply a name, the method calls the [GetCommandLine](/windows/desktop/api/processenv/nf-processenv-getcommandlinea) function and parses the command line. If a name cannot be found, the method fails.
7271

7372
## -returns
7473

75-
If the function succeeds, the function returns <b>S_OK</b>.
74+
If the function succeeds, the function returns **S_OK**.
7675

77-
If the function fails, it returns an <b>HRESULT</b> value that indicates the error. For a list of common error codes, see <a href="/windows/desktop/SecCrypto/common-hresult-values">Common HRESULT Values</a>.
76+
If the function fails, it returns an **HRESULT** value that indicates the error. For a list of common error codes, see [Common HRESULT Values](/windows/win32/SecCrypto/common-hresult-values).
7877

7978
## -remarks
8079

81-
The <a href="/windows/desktop/SecGloss/o-gly">object identifier</a> (OID) for this attribute is <b>XCN_OID_REQUEST_CLIENT_INFO</b> (1.3.6.1.4.1.311.21.20). For more information, see <a href="/windows/desktop/api/certenroll/ne-certenroll-certenroll_objectid">CERTENROLL_OBJECTID</a>. The attribute is created as an <a href="/windows/desktop/SecGloss/a-gly">Abstract Syntax Notation One</a> (ASN.1) structure that is encoded by using <a href="/windows/desktop/SecGloss/d-gly">Distinguished Encoding Rules</a> (DER).
82-
83-
You must call either <b>InitializeEncode</b> or <a href="/windows/desktop/api/certenroll/nf-certenroll-ix509attributeclientid-initializedecode">InitializeDecode</a> before you can use an <a href="/windows/desktop/api/certenroll/nn-certenroll-ix509attributeclientid">IX509AttributeClientId</a> object. The two methods complement each other. The <b>InitializeEncode</b> method enables you to construct an encoded ASN.1 structure from raw data, and the <b>InitializeDecode</b> method enables you to initialize raw data from an encoded ASN.1 structure. You can call the following properties to retrieve the raw data:<ul>
84-
<li>
85-
<a href="/windows/desktop/api/certenroll/nf-certenroll-ix509attributeclientid-get_clientid">ClientId</a>
86-
</li>
87-
<li>
88-
<a href="/windows/desktop/api/certenroll/nf-certenroll-ix509attributeclientid-get_machinednsname">MachineDnsName</a>
89-
</li>
90-
<li>
91-
<a href="/windows/desktop/api/certenroll/nf-certenroll-ix509attributeclientid-get_processname">ProcessName</a>
92-
</li>
93-
<li>
94-
<a href="/windows/desktop/api/certenroll/nf-certenroll-ix509attributeclientid-get_usersamname">UserSamName</a>
95-
</li>
96-
</ul>
80+
The [object identifier](/windows/win32/SecGloss/o-gly) (OID) for this attribute is **XCN_OID_REQUEST_CLIENT_INFO** (1.3.6.1.4.1.311.21.20). For more information, see [CERTENROLL_OBJECTID](/windows/win32/api/certenroll/ne-certenroll-certenroll_objectid). The attribute is created as an [Abstract Syntax Notation One](/windows/win32/SecGloss/a-gly) (ASN.1) structure that is encoded by using [Distinguished Encoding Rules](/windows/win32/SecGloss/d-gly) (DER).
81+
82+
You must call either **InitializeEncode** or [InitializeDecode](nf-certenroll-ix509attributeclientid-initializedecode.md) before you can use an [IX509AttributeClientId](nn-certenroll-ix509attributeclientid.md) object. The two methods complement each other. The **InitializeEncode** method enables you to construct an encoded ASN.1 structure from raw data, and the **InitializeDecode** method enables you to initialize raw data from an encoded ASN.1 structure. You can call the following properties to retrieve the raw data:
83+
84+
- [ClientId](nf-certenroll-ix509attributeclientid-get_clientid.md)
85+
- [MachineDnsName](nf-certenroll-ix509attributeclientid-get_machinednsname.md)
86+
- [ProcessName](nf-certenroll-ix509attributeclientid-get_processname.md)
87+
- [UserSamName](nf-certenroll-ix509attributeclientid-get_usersamname.md)
9788

9889
## -see-also
9990

100-
<a href="/windows/desktop/api/certenroll/nn-certenroll-ix509attributeclientid">IX509AttributeClientId</a>
91+
[IX509AttributeClientId](nn-certenroll-ix509attributeclientid.md)
92+
93+
[InitializeDecode](nf-certenroll-ix509attributeclientid-initializedecode.md)

0 commit comments

Comments
 (0)