Expand description
Status codes and error mapping for the Hurray C ABI.
All exported extern "C" functions return a HurrayStatus integer. Zero
indicates success; negative values indicate a specific error condition.
Callers MUST check the return value of every function before using output
pointer arguments.
Constants§
- HURRAY_
ERR_ BUFFER_ TOO_ SMALL - An output buffer is too small to hold the result.
- HURRAY_
ERR_ INDEX_ OUT_ OF_ BOUNDS - An index argument is outside the valid range for the collection.
- HURRAY_
ERR_ INTERNAL - An unclassified internal error occurred.
- HURRAY_
ERR_ INTERNAL_ PANIC - The function panicked internally; the handle MUST NOT be reused.
- HURRAY_
ERR_ INVALID_ LAYOUT - A layout descriptor field or tag is invalid.
- HURRAY_
ERR_ INVALID_ MAGIC - The descriptor magic bytes were not
"HRRY"(0x48 0x52 0x52 0x59). - HURRAY_
ERR_ INVALID_ SYNC_ MODE - The sync mode byte is not a recognized value.
- HURRAY_
ERR_ INVALID_ TYPE - A type tag, device tag, or memory class is invalid.
- HURRAY_
ERR_ NULL_ POINTER - A required pointer argument is null.
- HURRAY_
ERR_ SYNC_ MODE_ MISMATCH - A sync-mode handoff payload does not match the buffer’s declared sync mode.
- HURRAY_
ERR_ VERSION_ MISMATCH - The descriptor version is not supported by this implementation.
- HURRAY_
OK - Operation completed successfully.
Type Aliases§
- Hurray
Status - Integer status code returned by every Hurray C ABI function.