[MS-ERREF]: Windows Error Codes

[Pages:497][MS-ERREF]:

Windows Error Codes

Intellectual Property Rights Notice for Open Specifications Documentation

Technical Documentation. Microsoft publishes Open Specifications documentation ("this documentation") for protocols, file formats, data portability, computer languages, and standards support. Additionally, overview documents cover inter-protocol relationships and interactions.

Copyrights. This documentation is covered by Microsoft copyrights. Regardless of any other terms that are contained in the terms of use for the Microsoft website that hosts this documentation, you can make copies of it in order to develop implementations of the technologies that are described in this documentation and can distribute portions of it in your implementations that use these technologies or in your documentation as necessary to properly document the implementation. You can also distribute in your implementation, with or without modification, any schemas, IDLs, or code samples that are included in the documentation. This permission also applies to any documents that are referenced in the Open Specifications documentation.

No Trade Secrets. Microsoft does not claim any trade secret rights in this documentation. Patents. Microsoft has patents that might cover your implementations of the technologies

described in the Open Specifications documentation. Neither this notice nor Microsoft's delivery of this documentation grants any licenses under those patents or any other Microsoft patents. However, a given Open Specifications document might be covered by the Microsoft Open Specifications Promise or the Microsoft Community Promise. If you would prefer a written license, or if the technologies described in this documentation are not covered by the Open Specifications Promise or Community Promise, as applicable, patent licenses are available by contacting iplg@. License Programs. To see all of the protocols in scope under a specific license program and the associated patents, visit the Patent Map. Trademarks. The names of companies and products contained in this documentation might be covered by trademarks or similar intellectual property rights. This notice does not grant any licenses under those rights. For a list of Microsoft trademarks, visit trademarks. Fictitious Names. The example companies, organizations, products, domain names, email addresses, logos, people, places, and events that are depicted in this documentation are fictitious. No association with any real company, organization, product, domain name, email address, logo, person, place, or event is intended or should be inferred.

Reservation of Rights. All other rights are reserved, and this notice does not grant any rights other than as specifically described above, whether by implication, estoppel, or otherwise.

Tools. The Open Specifications documentation does not require the use of Microsoft programming tools or programming environments in order for you to develop an implementation. If you have access to Microsoft programming tools and environments, you are free to take advantage of them. Certain Open Specifications documents are intended for use in conjunction with publicly available standards specifications and network programming art and, as such, assume that the reader either is familiar with the aforementioned material or has immediate access to it.

Support. For questions and support, please contact dochelp@.

[MS-ERREF] - v20170601 Windows Error Codes Copyright ? 2017 Microsoft Corporation Release: June 1, 2017

1 / 497

Revision Summary

Date

Revision History

2/14/2008 5.0.3

3/14/2008 5.1

5/16/2008 5.1.1

6/20/2008 5.2

7/25/2008 5.2.1

8/29/2008 5.2.2

10/24/2008 5.2.3

12/5/2008 5.3

1/16/2009 5.3.1

2/27/2009 5.3.2

4/10/2009 6.0

5/22/2009 7.0

7/2/2009

7.1

8/14/2009 8.0

9/25/2009 8.1

11/6/2009 8.2

12/18/2009 9.0

1/29/2010 9.0.1

3/12/2010 9.0.2

4/23/2010 9.0.3

6/4/2010

9.0.4

7/16/2010 9.0.4

8/27/2010 9.0.4

10/8/2010 9.0.4

11/19/2010 10.0

1/7/2011

11.0

2/11/2011 11.0

3/25/2011 12.0

Revision Class Editorial Minor Editorial Minor Editorial Editorial Editorial Minor Editorial Editorial Major Major Minor Major Minor Minor Major Editorial Editorial Editorial Editorial

None

None

None

Major Major

None

Major

[MS-ERREF] - v20170601 Windows Error Codes Copyright ? 2017 Microsoft Corporation Release: June 1, 2017

Comments Changed language and formatting in the technical content. Clarified the meaning of the technical content. Changed language and formatting in the technical content. Clarified the meaning of the technical content. Changed language and formatting in the technical content. Changed language and formatting in the technical content. Changed language and formatting in the technical content. Clarified the meaning of the technical content. Editorial Update. Changed language and formatting in the technical content. Updated and revised the technical content. Updated and revised the technical content. Clarified the meaning of the technical content. Updated and revised the technical content. Clarified the meaning of the technical content. Clarified the meaning of the technical content. Updated and revised the technical content. Changed language and formatting in the technical content. Changed language and formatting in the technical content. Changed language and formatting in the technical content. Changed language and formatting in the technical content. No changes to the meaning, language, or formatting of the technical content. No changes to the meaning, language, or formatting of the technical content. No changes to the meaning, language, or formatting of the technical content. Updated and revised the technical content. Updated and revised the technical content. No changes to the meaning, language, or formatting of the technical content. Updated and revised the technical content.

2 / 497

Date

Revision History

5/6/2011

12.0

6/17/2011 12.1 9/23/2011 12.2 12/16/2011 13.0 3/30/2012 13.1

7/12/2012 13.1

10/25/2012 13.1

1/31/2013 13.1

8/8/2013

14.0

11/14/2013 14.1

2/13/2014 14.2

5/15/2014 14.2

6/30/2015 15.0

10/16/2015 15.0

7/14/2016 6/1/2017

16.0 17.0

Revision Class None Minor Minor Major Minor None

None

None Major Minor Minor None Major None Major Major

Comments

No changes to the meaning, language, or formatting of the technical content.

Clarified the meaning of the technical content.

Clarified the meaning of the technical content.

Updated and revised the technical content.

Clarified the meaning of the technical content.

No changes to the meaning, language, or formatting of the technical content.

No changes to the meaning, language, or formatting of the technical content.

No changes to the meaning, language, or formatting of the technical content.

Updated and revised the technical content.

Clarified the meaning of the technical content.

Clarified the meaning of the technical content.

No changes to the meaning, language, or formatting of the technical content.

Significantly changed the technical content.

No changes to the meaning, language, or formatting of the technical content.

Significantly changed the technical content.

Significantly changed the technical content.

[MS-ERREF] - v20170601 Windows Error Codes Copyright ? 2017 Microsoft Corporation Release: June 1, 2017

3 / 497

Table of Contents

1 Introduction ............................................................................................................ 5 1.1 Glossary ........................................................................................................... 5 1.2 References ........................................................................................................ 5 1.2.1 Normative References ................................................................................... 5 1.2.2 Informative References ................................................................................. 6 1.3 Overview .......................................................................................................... 6 1.4 Relationship to Protocols and Other Structures ...................................................... 6 1.5 Applicability Statement ....................................................................................... 6 1.6 Versioning and Localization ................................................................................. 6 1.7 Vendor Extensible Fields ..................................................................................... 6

2 Structures ............................................................................................................... 7 2.1 HRESULT .......................................................................................................... 7 2.1.1 HRESULT Values ......................................................................................... 10 2.1.2 HRESULT From WIN32 Error Code Macro ......................................................203 2.2 Win32 Error Codes ..........................................................................................203 2.3 NTSTATUS .....................................................................................................377 2.3.1 NTSTATUS Values ......................................................................................377 2.4 LDAP Error to Win32 Error Mapping ...................................................................490

3 Structure Example ............................................................................................... 495

4 Security Considerations ....................................................................................... 496

5 Appendix A: Product Behavior ............................................................................. 497

6 Change Tracking.................................................................................................. 499

7 Index................................................................................................................... 500

[MS-ERREF] - v20170601 Windows Error Codes Copyright ? 2017 Microsoft Corporation Release: June 1, 2017

4 / 497

1 Introduction

The Windows Error Codes document is a companion reference to the protocol specifications. It documents the common usage details for those HRESULT values, Win32 error codes, and NTSTATUS values that are referenced by specifications in the protocol documentation set.

Sections 1.7 and 2 of this specification are normative. All other sections and examples in this specification are informative.

1.1 Glossary

This document uses the following terms:

HRESULT: An integer value that indicates the result or status of an operation. A particular HRESULT can have different meanings depending on the protocol using it. See [MS-ERREF] section 2.1 and specific protocol documents for further details.

message identifier: A string that uniquely identifies an email message.

terminal server: A computer on which terminal services is running.

terminal services (TS): A service on a server computer that allows delivery of applications, or the desktop itself, to various computing devices. When a user runs an application on a terminal server, the application execution takes place on the server computer and only keyboard, mouse, and display information is transmitted over the network. Each user sees only his or her individual session, which is managed transparently by the server operating system and is independent of any other client session.

universally unique identifier (UUID): A 128-bit value. UUIDs can be used for multiple purposes, from tagging objects with an extremely short lifetime, to reliably identifying very persistent objects in cross-process communication such as client and server interfaces, manager entry-point vectors, and RPC objects. UUIDs are highly likely to be unique. UUIDs are also known as globally unique identifiers (GUIDs) and these terms are used interchangeably in the Microsoft protocol technical documents (TDs). Interchanging the usage of these terms does not imply or require a specific algorithm or mechanism to generate the UUID. Specifically, the use of this term does not imply or require that the algorithms described in [RFC4122] or [C706] must be used for generating the UUID.

MAY, SHOULD, MUST, SHOULD NOT, MUST NOT: These terms (in all caps) are used as defined in [RFC2119]. All statements of optional behavior use either MAY, SHOULD, or SHOULD NOT.

1.2 References

Links to a document in the Microsoft Open Specifications library point to the correct section in the most recently published version of the referenced document. However, because individual documents in the library are not updated at the same time, the section numbers in the documents may not match. You can confirm the correct section numbering by checking the Errata.

1.2.1 Normative References

We conduct frequent surveys of the normative references to assure their continued availability. If you have any issue with finding a normative reference, please contact dochelp@. We will assist you in finding the relevant information.

[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997,

[MS-ERREF] - v20170601 Windows Error Codes Copyright ? 2017 Microsoft Corporation Release: June 1, 2017

5 / 497

[RFC2251] Wahl, M., Howes, T., and Kille, S., "Lightweight Directory Access Protocol (v3)", RFC 2251, December 1997,

1.2.2 Informative References None.

1.3 Overview If a protocol returns HRESULTs, the protocol uses HRESULTs, as specified in section 2.1. If a protocol uses Win32 error codes, these values are taken from the Windows error number space, as specified in section 2.2. If a protocol uses NTSTATUS values, these values are specified in section 2.3.

1.4 Relationship to Protocols and Other Structures The structures documented in this specification do not depend on any other structures or protocols. The structures in this document are returned by many protocols.

1.5 Applicability Statement The data types specified in this document are applicable for use in any protocol that needs to include a discrete set of error codes.

1.6 Versioning and Localization The structures in the Windows Error Codes require no versioning or localization information.

1.7 Vendor Extensible Fields HRESULTs: Vendors can choose their own values, as long as the C bit (0x20000000) is set, indicating it is a customer code. The structures documented in this specification have no vendor-extensible fields. Win32 Error Codes: Vendors can only reuse these values with their indicated meanings. Choosing any other value runs the risk of a collision in the future. NTSTATUS: Vendors can choose their own values for this field, as long as the C bit (0x20000000) is set, indicating it is a customer code.

[MS-ERREF] - v20170601 Windows Error Codes Copyright ? 2017 Microsoft Corporation Release: June 1, 2017

6 / 497

2 Structures

2.1 HRESULT

The HRESULT numbering space is vendor-extensible. Vendors can supply their own values for this field, as long as the C bit (0x20000000) is set, indicating it is a customer code.

The HRESULT numbering space has the following internal structure. Any protocol that uses NTSTATUS values on the wire is responsible for stating the order in which the bytes are placed on the wire.

1

2

3

0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1

S R C N X

Facility

Code

S (1 bit): Severity. If set, indicates a failure result. If clear, indicates a success result.

R (1 bit): Reserved. If the N bit is clear, this bit MUST be set to 0. If the N bit is set, this bit is defined by the NTSTATUS numbering space (as specified in section 2.3).

C (1 bit): Customer. This bit specifies if the value is customer-defined or Microsoft-defined. The bit is set for customer-defined values and clear for Microsoft-defined values.

N (1 bit): If set, indicates that the error code is an NTSTATUS value (as specified in section 2.3), except that this bit is set.

X (1 bit): Reserved. SHOULD be set to 0.

Facility (11 bits): An indicator of the source of the error. New facilities are occasionally added by Microsoft.

The following table lists the currently defined facility codes:

Value

FACILITY_NULL 0

FACILITY_RPC 1

FACILITY_DISPATCH 2

FACILITY_STORAGE 3

FACILITY_ITF 4

FACILITY_WIN32 7

FACILITY_WINDOWS 8

FACILITY_SECURITY

Meaning The default facility code.

The source of the error code is an RPC subsystem.

The source of the error code is a COM Dispatch.

The source of the error code is OLE Storage.

The source of the error code is COM/OLE Interface management.

This region is reserved to map undecorated error codes into HRESULTs. The source of the error code is the Windows subsystem.

The source of the error code is the Security API layer.

[MS-ERREF] - v20170601 Windows Error Codes Copyright ? 2017 Microsoft Corporation Release: June 1, 2017

7 / 497

Value 9

Meaning

FACILITY_SSPI 9

The source of the error code is the Security API layer.

FACILITY_CONTROL 10

The source of the error code is the control mechanism.

FACILITY_CERT 11

The source of the error code is a certificate client or server?

FACILITY_INTERNET 12

The source of the error code is Wininet related.

FACILITY_MEDIASERVER 13

The source of the error code is the Windows Media Server.

FACILITY_MSMQ 14

The source of the error code is the Microsoft Message Queue.

FACILITY_SETUPAPI 15

The source of the error code is the Setup API.

FACILITY_SCARD 16

The source of the error code is the Smart-card subsystem.

FACILITY_COMPLUS 17

The source of the error code is COM+.

FACILITY_AAF 18

The source of the error code is the Microsoft agent.

FACILITY_URT 19

The source of the error code is .NET CLR.

FACILITY_ACS 20

The source of the error code is the audit collection service.

FACILITY_DPLAY 21

The source of the error code is Direct Play.

FACILITY_UMI 22

The source of the error code is the ubiquitous memoryintrospection service.

FACILITY_SXS 23

The source of the error code is Side-by-side servicing.

FACILITY_WINDOWS_CE 24

The error code is specific to Windows CE.

FACILITY_HTTP 25

The source of the error code is HTTP support.

FACILITY_USERMODE_COMMONLOG 26

The source of the error code is common Logging support.

FACILITY_USERMODE_FILTER_MANAGER The source of the error code is the user mode filter manager.

[MS-ERREF] - v20170601 Windows Error Codes Copyright ? 2017 Microsoft Corporation Release: June 1, 2017

8 / 497

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download