[ms-erref]: Windows Error Codes Intellectual Property Rights Notice for Open Specifications Documentation



Download 355.48 Kb.
Page2/52
Date02.12.2016
Size355.48 Kb.
1   2   3   4   5   6   7   8   9   ...   52

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 and can contain the terms MAY, SHOULD, MUST, MUST NOT, and SHOULD NOT as defined in [RFC2119]. All other sections and examples in this specification are informative.


    1. Glossary


The following terms are specific to this document:

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. 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. 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@microsoft.com. 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, http://www.rfc-editor.org/rfc/rfc2119.txt

[RFC2251] Wahl, M., Howes, T., and Kille, S., "Lightweight Directory Access Protocol (v3)", RFC 2251, December 1997, http://www.ietf.org/rfc/rfc2251.txt

      1. Informative References


None.
    1. 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. 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. 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. Versioning and Localization


The structures in the Windows Error Codes require no versioning or localization information.
    1. 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 should reuse those 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.
  1. Structures

    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.



0

1

2

3

4

5

6

7

8

9

1

0


1

2

3

4

5

6

7

8

9

2

0


1

2

3

4

5

6

7

8

9

3

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.<1>

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. <2>

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

Meaning




FACILITY_NULL

0


The default facility code.

FACILITY_RPC

1


The source of the error code is an RPC subsystem.

FACILITY_DISPATCH

2


The source of the error code is a COM Dispatch.

FACILITY_STORAGE

3


The source of the error code is OLE Storage.

FACILITY_ITF

4


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

FACILITY_WIN32

7


This region is reserved to map undecorated error codes into HRESULTs.

FACILITY_WINDOWS

8


The source of the error code is the Windows subsystem.

FACILITY_SECURITY

9


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

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

31


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

FACILITY_BACKGROUNDCOPY

32


The source of the error code is background copy control

FACILITY_CONFIGURATION

33


The source of the error code is configuration services.

FACILITY_STATE_MANAGEMENT

34


The source of the error code is state management services.

FACILITY_METADIRECTORY

35


The source of the error code is the Microsoft Identity Server.

FACILITY_WINDOWSUPDATE

36


The source of the error code is a Windows update.

FACILITY_DIRECTORYSERVICE

37


The source of the error code is Active Directory.

FACILITY_GRAPHICS

38


The source of the error code is the graphics drivers.

FACILITY_SHELL

39


The source of the error code is the user Shell.

FACILITY_TPM_SERVICES

40


The source of the error code is the Trusted Platform Module services.

FACILITY_TPM_SOFTWARE

41


The source of the error code is the Trusted Platform Module applications.

FACILITY_PLA

48


The source of the error code is Performance Logs and Alerts

FACILITY_FVE

49


The source of the error code is Full volume encryption.

FACILITY_FWP

50


he source of the error code is the Firewall Platform.

FACILITY_WINRM

51


The source of the error code is the Windows Resource Manager.

FACILITY_NDIS

52


The source of the error code is the Network Driver Interface.

FACILITY_USERMODE_HYPERVISOR

53


The source of the error code is the Usermode Hypervisor components.

FACILITY_CMI

54


The source of the error code is the Configuration Management Infrastructure.

FACILITY_USERMODE_VIRTUALIZATION

55


The source of the error code is the user mode virtualization subsystem.

FACILITY_USERMODE_VOLMGR

56


The source of the error code is the user mode volume manager

FACILITY_BCD

57


The source of the error code is the Boot Configuration Database.

FACILITY_USERMODE_VHD

58


The source of the error code is user mode virtual hard disk support.

FACILITY_SDIAG

60


The source of the error code is System Diagnostics.

FACILITY_WEBSERVICES

61


The source of the error code is the Web Services.

FACILITY_WINDOWS_DEFENDER

80


The source of the error code is a Windows Defender component.

FACILITY_OPC

81


The source of the error code is the open connectivity service.

Code (2 bytes): The remainder of the error code.



      1. Share with your friends:
1   2   3   4   5   6   7   8   9   ...   52


The database is protected by copyright ©dentisty.org 2019
send message

    Main page