Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

The cl-win32-errors Reference Manual

This is the cl-win32-errors Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Fri May 15 12:04:07 2026 GMT+0.

1 Introduction
2 Systems
- 2.1 cl-win32-errors
3 Modules
- 3.1 cl-win32-errors/src
4 Files
- 4.1 Lisp
5 Packages
- 5.1 cl-win32-errors
6 Definitions
- 6.1 Public Interface
- 6.2 Internals
Appendix A Indexes

Next: Systems, Previous: The cl-win32-errors Reference Manual, Up: The cl-win32-errors Reference Manual [Contents][Index]

1 Introduction

Next: Modules, Previous: Introduction, Up: The cl-win32-errors Reference Manual [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.

cl-win32-errors

Previous: Systems, Up: Systems [Contents][Index]

2.1 `cl-win32-errors`

A library for translating Windows API error codes.

Author

Andrew D. France <andrewforlua@gmail.com>

License

MIT

Version

1.0.0

Source

cl-win32-errors.asd.

Child Components

package.lisp (file).
cl-win32-errors.lisp (file).
src (module).

Next: Files, Previous: Systems, Up: The cl-win32-errors Reference Manual [Contents][Index]

3 Modules

Modules are listed depth-first from the system components tree.

cl-win32-errors/src

Previous: Modules, Up: Modules [Contents][Index]

3.1 `cl-win32-errors/src`

Dependency

cl-win32-errors.lisp (file).

Source

cl-win32-errors.asd.

Parent Component

cl-win32-errors (system).

Child Components

core.lisp (file).
network.lisp (file).
rpc.lisp (file).
security.lisp (file).
extended.lisp (file).
cluster.lisp (file).
transactional.lisp (file).
ds.lisp (file).
dns.lisp (file).
winsock.lisp (file).

Next: Packages, Previous: Modules, Up: The cl-win32-errors Reference Manual [Contents][Index]

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

Lisp

Previous: Files, Up: Files [Contents][Index]

Next: cl-win32-errors/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `cl-win32-errors/cl-win32-errors.asd`

Source: cl-win32-errors.asd.
Parent Component: cl-win32-errors (system).
ASDF Systems: cl-win32-errors.

Next: cl-win32-errors/cl-win32-errors.lisp, Previous: cl-win32-errors/cl-win32-errors.asd, Up: Lisp [Contents][Index]

4.1.2 `cl-win32-errors/package.lisp`

Source: cl-win32-errors.asd.
Parent Component: cl-win32-errors (system).
Packages: cl-win32-errors.

Next: cl-win32-errors/src/core.lisp, Previous: cl-win32-errors/package.lisp, Up: Lisp [Contents][Index]

4.1.3 `cl-win32-errors/cl-win32-errors.lisp`

Dependency

package.lisp (file).

Source

cl-win32-errors.asd.

Parent Component

cl-win32-errors (system).

Public Interface

format-error-message (function).
get-error-details (function).
win32-error (condition).
win32-error-code (reader method).
win32-error-description (function).
win32-error-symbol (function).

Internals

*win32-error-map* (special variable).
register-error (function).
win32-error-details (reader method).

Next: cl-win32-errors/src/network.lisp, Previous: cl-win32-errors/cl-win32-errors.lisp, Up: Lisp [Contents][Index]

4.1.4 `cl-win32-errors/src/core.lisp`

Source: cl-win32-errors.asd.
Parent Component: src (module).

Next: cl-win32-errors/src/rpc.lisp, Previous: cl-win32-errors/src/core.lisp, Up: Lisp [Contents][Index]

4.1.5 `cl-win32-errors/src/network.lisp`

Source: cl-win32-errors.asd.
Parent Component: src (module).

Next: cl-win32-errors/src/security.lisp, Previous: cl-win32-errors/src/network.lisp, Up: Lisp [Contents][Index]

4.1.6 `cl-win32-errors/src/rpc.lisp`

Source: cl-win32-errors.asd.
Parent Component: src (module).

Next: cl-win32-errors/src/extended.lisp, Previous: cl-win32-errors/src/rpc.lisp, Up: Lisp [Contents][Index]

4.1.7 `cl-win32-errors/src/security.lisp`

Source: cl-win32-errors.asd.
Parent Component: src (module).

Next: cl-win32-errors/src/cluster.lisp, Previous: cl-win32-errors/src/security.lisp, Up: Lisp [Contents][Index]

4.1.8 `cl-win32-errors/src/extended.lisp`

Source: cl-win32-errors.asd.
Parent Component: src (module).

Next: cl-win32-errors/src/transactional.lisp, Previous: cl-win32-errors/src/extended.lisp, Up: Lisp [Contents][Index]

4.1.9 `cl-win32-errors/src/cluster.lisp`

Source: cl-win32-errors.asd.
Parent Component: src (module).

Next: cl-win32-errors/src/ds.lisp, Previous: cl-win32-errors/src/cluster.lisp, Up: Lisp [Contents][Index]

4.1.10 `cl-win32-errors/src/transactional.lisp`

Source: cl-win32-errors.asd.
Parent Component: src (module).

Next: cl-win32-errors/src/dns.lisp, Previous: cl-win32-errors/src/transactional.lisp, Up: Lisp [Contents][Index]

4.1.11 `cl-win32-errors/src/ds.lisp`

Source: cl-win32-errors.asd.
Parent Component: src (module).

Next: cl-win32-errors/src/winsock.lisp, Previous: cl-win32-errors/src/ds.lisp, Up: Lisp [Contents][Index]

4.1.12 `cl-win32-errors/src/dns.lisp`

Source: cl-win32-errors.asd.
Parent Component: src (module).

Previous: cl-win32-errors/src/dns.lisp, Up: Lisp [Contents][Index]

4.1.13 `cl-win32-errors/src/winsock.lisp`

Source: cl-win32-errors.asd.
Parent Component: src (module).

Next: Definitions, Previous: Files, Up: The cl-win32-errors Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

cl-win32-errors

Previous: Packages, Up: Packages [Contents][Index]

5.1 `cl-win32-errors`

Provides utilities for handling Windows API error codes.

Source

package.lisp.

Use List

common-lisp.

Public Interface

format-error-message (function).
get-error-details (function).
win32-error (condition).
win32-error-code (generic reader).
win32-error-description (function).
win32-error-symbol (function).

Internals

*win32-error-map* (special variable).
register-error (function).
win32-error-details (generic reader).

Next: Indexes, Previous: Packages, Up: The cl-win32-errors Reference Manual [Contents][Index]

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

6.1 Public Interface

Ordinary functions
Generic functions
Conditions

Next: Generic functions, Previous: Public Interface, Up: Public Interface [Contents][Index]

6.1.1 Ordinary functions

Function: format-error-message (error-code &key verbosity) ¶

Formats a Win32 error code into a human-readable string. VERBOSITY can be :DEFAULT or :VERBOSE.

Package: cl-win32-errors.
Source: cl-win32-errors.lisp.

Function: get-error-details (error-code) ¶

Looks up a Win32 error code and returns a plist of its details. Returns NIL if the code is not found.

Package: cl-win32-errors.
Source: cl-win32-errors.lisp.

Function: win32-error-description (condition) ¶

Returns the descriptive string for the error.

Package: cl-win32-errors.
Source: cl-win32-errors.lisp.

Function: win32-error-symbol (condition) ¶

Returns the symbolic name of the error, e.g., :ERROR_ACCESS_DENIED.

Package: cl-win32-errors.
Source: cl-win32-errors.lisp.

Next: Conditions, Previous: Ordinary functions, Up: Public Interface [Contents][Index]

6.1.2 Generic functions

Generic Reader: win32-error-code (condition) ¶

Package

cl-win32-errors.

Methods

Reader Method: win32-error-code ((condition win32-error)) ¶

Source: cl-win32-errors.lisp.
Target Slot: code.

Previous: Generic functions, Up: Public Interface [Contents][Index]

6.1.3 Conditions

Condition: win32-error ¶

Package

cl-win32-errors.

Source

cl-win32-errors.lisp.

Direct superclasses

error.

Direct methods

win32-error-code.
win32-error-details.

Direct slots

Slot: code ¶

Initargs: :code
Readers: win32-error-code.
Writers: This slot is read-only.

Slot: details ¶

Initargs: :details
Readers: win32-error-details.
Writers: This slot is read-only.

Previous: Public Interface, Up: Definitions [Contents][Index]

6.2 Internals

Special variables
Ordinary functions
Generic functions

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

6.2.1 Special variables

Special Variable: *win32-error-map* ¶

A hash table mapping numeric error codes to their details.

Package: cl-win32-errors.
Source: cl-win32-errors.lisp.

Next: Generic functions, Previous: Special variables, Up: Internals [Contents][Index]

6.2.2 Ordinary functions

Function: register-error (code symbol description) ¶

Registers a Win32 error code and its details in the database.

Package: cl-win32-errors.
Source: cl-win32-errors.lisp.

Previous: Ordinary functions, Up: Internals [Contents][Index]

6.2.3 Generic functions

Generic Reader: win32-error-details (condition) ¶

Package

cl-win32-errors.

Methods

Reader Method: win32-error-details ((condition win32-error)) ¶

Source: cl-win32-errors.lisp.
Target Slot: details.

Previous: Definitions, Up: The cl-win32-errors Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

A.2 Functions

Jump to:	F G M R W

	Index Entry	Section

F
	`format-error-message`:	Public ordinary functions
	`Function, format-error-message`:	Public ordinary functions
	`Function, get-error-details`:	Public ordinary functions
	`Function, register-error`:	Private ordinary functions
	`Function, win32-error-description`:	Public ordinary functions
	`Function, win32-error-symbol`:	Public ordinary functions

G
	`Generic Function, win32-error-code`:	Public generic functions
	`Generic Function, win32-error-details`:	Private generic functions
	`get-error-details`:	Public ordinary functions

M
	`Method, win32-error-code`:	Public generic functions
	`Method, win32-error-details`:	Private generic functions

R
	`register-error`:	Private ordinary functions

W
	`win32-error-code`:	Public generic functions
	`win32-error-code`:	Public generic functions
	`win32-error-description`:	Public ordinary functions
	`win32-error-details`:	Private generic functions
	`win32-error-details`:	Private generic functions
	`win32-error-symbol`:	Public ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* C D S

	Index Entry	Section

*
	`win32-error-map`:	Private special variables

C
	`code`:	Public conditions

D
	`details`:	Public conditions

S
	`Slot, code`:	Public conditions
	`Slot, details`:	Public conditions
	`Special Variable, win32-error-map`:	Private special variables

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	C D E F M N P R S T W

	Index Entry	Section

C
	`cl-win32-errors`:	The cl-win32-errors system
	`cl-win32-errors`:	The cl-win32-errors package
	`cl-win32-errors.asd`:	The cl-win32-errors/cl-win32-errors․asd file
	`cl-win32-errors.lisp`:	The cl-win32-errors/cl-win32-errors․lisp file
	`cluster.lisp`:	The cl-win32-errors/src/cluster․lisp file
	`Condition, win32-error`:	Public conditions
	`core.lisp`:	The cl-win32-errors/src/core․lisp file

D
	`dns.lisp`:	The cl-win32-errors/src/dns․lisp file
	`ds.lisp`:	The cl-win32-errors/src/ds․lisp file

E
	`extended.lisp`:	The cl-win32-errors/src/extended․lisp file

F
	`File, cl-win32-errors.asd`:	The cl-win32-errors/cl-win32-errors․asd file
	`File, cl-win32-errors.lisp`:	The cl-win32-errors/cl-win32-errors․lisp file
	`File, cluster.lisp`:	The cl-win32-errors/src/cluster․lisp file
	`File, core.lisp`:	The cl-win32-errors/src/core․lisp file
	`File, dns.lisp`:	The cl-win32-errors/src/dns․lisp file
	`File, ds.lisp`:	The cl-win32-errors/src/ds․lisp file
	`File, extended.lisp`:	The cl-win32-errors/src/extended․lisp file
	`File, network.lisp`:	The cl-win32-errors/src/network․lisp file
	`File, package.lisp`:	The cl-win32-errors/package․lisp file
	`File, rpc.lisp`:	The cl-win32-errors/src/rpc․lisp file
	`File, security.lisp`:	The cl-win32-errors/src/security․lisp file
	`File, transactional.lisp`:	The cl-win32-errors/src/transactional․lisp file
	`File, winsock.lisp`:	The cl-win32-errors/src/winsock․lisp file

M
	`Module, src`:	The cl-win32-errors/src module

N
	`network.lisp`:	The cl-win32-errors/src/network․lisp file

P
	`Package, cl-win32-errors`:	The cl-win32-errors package
	`package.lisp`:	The cl-win32-errors/package․lisp file

R
	`rpc.lisp`:	The cl-win32-errors/src/rpc․lisp file

S
	`security.lisp`:	The cl-win32-errors/src/security․lisp file
	`src`:	The cl-win32-errors/src module
	`System, cl-win32-errors`:	The cl-win32-errors system

T
	`transactional.lisp`:	The cl-win32-errors/src/transactional․lisp file

W
	`win32-error`:	Public conditions
	`winsock.lisp`:	The cl-win32-errors/src/winsock․lisp file

The cl-win32-errors Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 cl-win32-errors

3 Modules

3.1 cl-win32-errors/src

4 Files

4.1 Lisp

4.1.1 cl-win32-errors/cl-win32-errors.asd

4.1.2 cl-win32-errors/package.lisp

4.1.3 cl-win32-errors/cl-win32-errors.lisp

4.1.4 cl-win32-errors/src/core.lisp

4.1.5 cl-win32-errors/src/network.lisp

4.1.6 cl-win32-errors/src/rpc.lisp

4.1.7 cl-win32-errors/src/security.lisp

4.1.8 cl-win32-errors/src/extended.lisp

4.1.9 cl-win32-errors/src/cluster.lisp

4.1.10 cl-win32-errors/src/transactional.lisp

4.1.11 cl-win32-errors/src/ds.lisp

4.1.12 cl-win32-errors/src/dns.lisp

4.1.13 cl-win32-errors/src/winsock.lisp

5 Packages

5.1 cl-win32-errors

6 Definitions

6.1 Public Interface

6.1.1 Ordinary functions

6.1.2 Generic functions

6.1.3 Conditions

6.2 Internals

6.2.1 Special variables

6.2.2 Ordinary functions

6.2.3 Generic functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cl-win32-errors`

3.1 `cl-win32-errors/src`

4.1.1 `cl-win32-errors/cl-win32-errors.asd`

4.1.2 `cl-win32-errors/package.lisp`

4.1.3 `cl-win32-errors/cl-win32-errors.lisp`

4.1.4 `cl-win32-errors/src/core.lisp`

4.1.5 `cl-win32-errors/src/network.lisp`

4.1.6 `cl-win32-errors/src/rpc.lisp`

4.1.7 `cl-win32-errors/src/security.lisp`

4.1.8 `cl-win32-errors/src/extended.lisp`

4.1.9 `cl-win32-errors/src/cluster.lisp`

4.1.10 `cl-win32-errors/src/transactional.lisp`

4.1.11 `cl-win32-errors/src/ds.lisp`

4.1.12 `cl-win32-errors/src/dns.lisp`

4.1.13 `cl-win32-errors/src/winsock.lisp`

5.1 `cl-win32-errors`