# SDK Reference (SDK Reference)

> Header-by-header reference for the Peios SDK — the conventions every call follows, then security descriptors, tokens, access checks, files, processes, the registry, events, msgpack, and the registry-source interface.

The whole book as one markdown file: [/peios/developing-for-peios/sdk-reference/print.md](/peios/developing-for-peios/sdk-reference/print.md)

Contents:

- 1 [Library Conventions](/peios/developing-for-peios/sdk-reference/sdk-conventions/library-conventions.md)
    - 1.1 [Library conventions](/peios/developing-for-peios/sdk-reference/sdk-conventions/library-conventions.md)
    - 1.2 [How results are returned](/peios/developing-for-peios/sdk-reference/sdk-conventions/how-results-are-returned.md)
    - 1.3 [The two-call buffer protocol](/peios/developing-for-peios/sdk-reference/sdk-conventions/the-two-call-buffer-protocol.md)
    - 1.4 [Memory ownership](/peios/developing-for-peios/sdk-reference/sdk-conventions/memory-ownership.md)
    - 1.5 [File descriptors](/peios/developing-for-peios/sdk-reference/sdk-conventions/file-descriptors.md)
    - 1.6 [Constants](/peios/developing-for-peios/sdk-reference/sdk-conventions/constants.md)
    - 1.7 [The conventions at a glance](/peios/developing-for-peios/sdk-reference/sdk-conventions/the-conventions-at-a-glance.md)
- 2 [security.h — SIDs and Descriptors](/peios/developing-for-peios/sdk-reference/sdk-security/security-h-security-descriptors.md)
    - 2.1 [security.h — Security descriptors](/peios/developing-for-peios/sdk-reference/sdk-security/security-h-security-descriptors.md)
    - 2.2 [SIDs](/peios/developing-for-peios/sdk-reference/sdk-security/sids.md)
    - 2.3 [Access masks](/peios/developing-for-peios/sdk-reference/sdk-security/access-masks.md)
    - 2.4 [Building ACLs](/peios/developing-for-peios/sdk-reference/sdk-security/building-acls.md)
    - 2.5 [Building security descriptors](/peios/developing-for-peios/sdk-reference/sdk-security/building-security-descriptors.md)
    - 2.6 [Parsing — views](/peios/developing-for-peios/sdk-reference/sdk-security/parsing-views.md)
    - 2.7 [SDDL text codec](/peios/developing-for-peios/sdk-reference/sdk-security/sddl-text-codec.md)
    - 2.8 [SD inheritance](/peios/developing-for-peios/sdk-reference/sdk-security/sd-inheritance.md)
- 3 [token.h — Tokens](/peios/developing-for-peios/sdk-reference/sdk-tokens/token-h-tokens-and-sessions.md)
    - 3.1 [token.h — Tokens and sessions](/peios/developing-for-peios/sdk-reference/sdk-tokens/token-h-tokens-and-sessions.md)
    - 3.2 [Opening and creating tokens](/peios/developing-for-peios/sdk-reference/sdk-tokens/opening-and-creating-tokens.md)
    - 3.3 [The token-spec builder](/peios/developing-for-peios/sdk-reference/sdk-tokens/the-token-spec-builder.md)
    - 3.4 [Query](/peios/developing-for-peios/sdk-reference/sdk-tokens/query.md)
    - 3.5 [Adjust and transform](/peios/developing-for-peios/sdk-reference/sdk-tokens/adjust-and-transform.md)
    - 3.6 [Logon sessions](/peios/developing-for-peios/sdk-reference/sdk-tokens/logon-sessions.md)
    - 3.7 [The generic mapping](/peios/developing-for-peios/sdk-reference/sdk-tokens/the-generic-mapping.md)
- 4 [access.h — Access Checks](/peios/developing-for-peios/sdk-reference/sdk-access/access-h-access-checks.md)
    - 4.1 [access.h — Access checks](/peios/developing-for-peios/sdk-reference/sdk-access/access-h-access-checks.md)
    - 4.2 [The request](/peios/developing-for-peios/sdk-reference/sdk-access/the-request.md)
    - 4.3 [The check](/peios/developing-for-peios/sdk-reference/sdk-access/the-check.md)
    - 4.4 [Audit outputs](/peios/developing-for-peios/sdk-reference/sdk-access/audit-outputs.md)
    - 4.5 [The object-type-list variant](/peios/developing-for-peios/sdk-reference/sdk-access/the-object-type-list-variant.md)
- 5 [file.h — File Security](/peios/developing-for-peios/sdk-reference/sdk-files/file-h-file-security.md)
    - 5.1 [file.h — File security](/peios/developing-for-peios/sdk-reference/sdk-files/file-h-file-security.md)
    - 5.2 [Opening a file](/peios/developing-for-peios/sdk-reference/sdk-files/opening-a-file.md)
    - 5.3 [Reading and writing a file's security descriptor](/peios/developing-for-peios/sdk-reference/sdk-files/reading-and-writing-a-file-s-security-descriptor.md)
    - 5.4 [Mount policy](/peios/developing-for-peios/sdk-reference/sdk-files/mount-policy.md)
    - 5.5 [The generic mapping](/peios/developing-for-peios/sdk-reference/sdk-files/the-generic-mapping.md)
- 6 [process.h — Process Security](/peios/developing-for-peios/sdk-reference/sdk-processes/process-h.md)
    - 6.1 [process.h — Process security](/peios/developing-for-peios/sdk-reference/sdk-processes/process-h.md)
- 7 [registry.h — The Registry](/peios/developing-for-peios/sdk-reference/sdk-registry-api/registry-h-the-registry-lcs.md)
    - 7.1 [registry.h — The registry (LCS)](/peios/developing-for-peios/sdk-reference/sdk-registry-api/registry-h-the-registry-lcs.md)
    - 7.2 [The buffer convention here](/peios/developing-for-peios/sdk-reference/sdk-registry-api/the-buffer-convention-here.md)
    - 7.3 [Opening and creating keys](/peios/developing-for-peios/sdk-reference/sdk-registry-api/opening-and-creating-keys.md)
    - 7.4 [Values](/peios/developing-for-peios/sdk-reference/sdk-registry-api/values.md)
    - 7.5 [Subkeys, metadata, and watches](/peios/developing-for-peios/sdk-reference/sdk-registry-api/subkeys-metadata-and-watches.md)
    - 7.6 [Key security descriptors](/peios/developing-for-peios/sdk-reference/sdk-registry-api/key-security-descriptors.md)
    - 7.7 [Backup and restore](/peios/developing-for-peios/sdk-reference/sdk-registry-api/backup-and-restore.md)
    - 7.8 [Transactions](/peios/developing-for-peios/sdk-reference/sdk-registry-api/transactions.md)
- 8 [event.h — Events](/peios/developing-for-peios/sdk-reference/sdk-events-api/event-h-events-kmes.md)
    - 8.1 [event.h — Events (KMES)](/peios/developing-for-peios/sdk-reference/sdk-events-api/event-h-events-kmes.md)
    - 8.2 [Emitting events](/peios/developing-for-peios/sdk-reference/sdk-events-api/emitting-events.md)
    - 8.3 [Consuming events](/peios/developing-for-peios/sdk-reference/sdk-events-api/consuming-events.md)
- 9 [msgpack.h — Encoding](/peios/developing-for-peios/sdk-reference/sdk-msgpack/msgpack-h-messagepack-codec.md)
    - 9.1 [msgpack.h — MessagePack codec](/peios/developing-for-peios/sdk-reference/sdk-msgpack/msgpack-h-messagepack-codec.md)
    - 9.2 [Conventions](/peios/developing-for-peios/sdk-reference/sdk-msgpack/conventions.md)
    - 9.3 [Writer](/peios/developing-for-peios/sdk-reference/sdk-msgpack/writer.md)
    - 9.4 [Reader](/peios/developing-for-peios/sdk-reference/sdk-msgpack/reader.md)
    - 9.5 [Validator](/peios/developing-for-peios/sdk-reference/sdk-msgpack/validator.md)
- 10 [rsi/source.h — Becoming a Source](/peios/developing-for-peios/sdk-reference/sdk-rsi-source/rsi-source-h-becoming-a-source.md)
    - 10.1 [rsi/source.h — Becoming a source](/peios/developing-for-peios/sdk-reference/sdk-rsi-source/rsi-source-h-becoming-a-source.md)
    - 10.2 [Describing a hive](/peios/developing-for-peios/sdk-reference/sdk-rsi-source/describing-a-hive.md)
    - 10.3 [Registering](/peios/developing-for-peios/sdk-reference/sdk-rsi-source/registering.md)
    - 10.4 [What comes next](/peios/developing-for-peios/sdk-reference/sdk-rsi-source/what-comes-next.md)
- 11 [rsi/request.h — Decoding Requests](/peios/developing-for-peios/sdk-reference/sdk-rsi-request/rsi-request-h-decoding-requests.md)
    - 11.1 [rsi/request.h — Decoding requests](/peios/developing-for-peios/sdk-reference/sdk-rsi-request/rsi-request-h-decoding-requests.md)
    - 11.2 [Reading and parsing a frame](/peios/developing-for-peios/sdk-reference/sdk-rsi-request/reading-and-parsing-a-frame.md)
    - 11.3 [The decoders](/peios/developing-for-peios/sdk-reference/sdk-rsi-request/the-decoders.md)
- 12 [rsi/response.h — Building Responses](/peios/developing-for-peios/sdk-reference/sdk-rsi-response/rsi-response-h-building-responses.md)
    - 12.1 [rsi/response.h — Building responses](/peios/developing-for-peios/sdk-reference/sdk-rsi-response/rsi-response-h-building-responses.md)
    - 12.2 [Status codes](/peios/developing-for-peios/sdk-reference/sdk-rsi-response/status-codes.md)
    - 12.3 [The response contract](/peios/developing-for-peios/sdk-reference/sdk-rsi-response/the-response-contract.md)
    - 12.4 [Sending a pre-built frame](/peios/developing-for-peios/sdk-reference/sdk-rsi-response/sending-a-pre-built-frame.md)
    - 12.5 [Status-only responses](/peios/developing-for-peios/sdk-reference/sdk-rsi-response/status-only-responses.md)
    - 12.6 [Payload-bearing responses](/peios/developing-for-peios/sdk-reference/sdk-rsi-response/payload-bearing-responses.md)
    - 12.7 [The five at a glance](/peios/developing-for-peios/sdk-reference/sdk-rsi-response/the-five-at-a-glance.md)