dttr_result.h File Reference

#include <stdbool.h>

Go to the source code of this file.

Data Structures
struct	DTTR_Result

Typedefs
typedef enum DTTR_Status	DTTR_Status
typedef struct DTTR_Result	DTTR_Result

Enumerations

enum

DTTR_Status {   DTTR_OK = 0 , DTTR_ERR_INVALID_ARGUMENT , DTTR_ERR_NOT_FOUND , DTTR_ERR_UNSUPPORTED ,   DTTR_ERR_ALREADY_INSTALLED , DTTR_ERR_NOT_INSTALLED , DTTR_ERR_MEMORY_PROTECTION , DTTR_ERR_RUNTIME_UNAVAILABLE ,   DTTR_ERR_ABI_MISMATCH , DTTR_ERR_OUT_OF_MEMORY , DTTR_ERR_HOOK_CHAIN_UNSUPPORTED , DTTR_ERR_MISSING_SYMBOL ,   DTTR_ERR_UNRESOLVED , DTTR_ERR_NOT_CALLABLE , DTTR_ERR_READ_FAILED , DTTR_ERR_WRITE_FAILED ,   DTTR_ERR_POLICY_MISMATCH , DTTR_ERR_UNSUPPORTED_LAYOUT , DTTR_ERR_UNSUPPORTED_CONTRACT , DTTR_ERR_PROVENANCE_UNSAFE }

Functions
const char *	DTTR_StatusName (DTTR_Status status)
bool	DTTR_StatusOK (DTTR_Status status)
bool	DTTR_StatusFailed (DTTR_Status status)
bool	DTTR_ResultOK (DTTR_Result result)

Detailed Description

Shared SDK status and result helpers.

Definition in file dttr_result.h.

Typedef Documentation

DTTR_Result

typedef struct DTTR_Result DTTR_Result

DTTR_Status

typedef enum DTTR_Status DTTR_Status

Enumeration Type Documentation

DTTR_Status

enum DTTR_Status

Enumerator
DTTR_OK
DTTR_ERR_INVALID_ARGUMENT
DTTR_ERR_NOT_FOUND
DTTR_ERR_UNSUPPORTED
DTTR_ERR_ALREADY_INSTALLED
DTTR_ERR_NOT_INSTALLED
DTTR_ERR_MEMORY_PROTECTION
DTTR_ERR_RUNTIME_UNAVAILABLE
DTTR_ERR_ABI_MISMATCH
DTTR_ERR_OUT_OF_MEMORY
DTTR_ERR_HOOK_CHAIN_UNSUPPORTED
DTTR_ERR_MISSING_SYMBOL
DTTR_ERR_UNRESOLVED
DTTR_ERR_NOT_CALLABLE
DTTR_ERR_READ_FAILED
DTTR_ERR_WRITE_FAILED
DTTR_ERR_POLICY_MISMATCH
DTTR_ERR_UNSUPPORTED_LAYOUT
DTTR_ERR_UNSUPPORTED_CONTRACT
DTTR_ERR_PROVENANCE_UNSAFE

Definition at line 13 of file dttr_result.h.

Function Documentation

DTTR_ResultOK()

bool DTTR_ResultOK

(

DTTR_Result

result

)

Report whether an SDK result represents success.

Parameters

result

Result object returned by an SDK operation.

Returns

true when result.status is DTTR_OK.

Definition at line 78 of file core.c.

References DTTR_StatusOK(), and DTTR_Result::status.

Referenced by aob_scan_with(), default_load_entry(), DTTR_Core_HookAOB(), DTTR_Core_PatchAOBRel32Jump(), DTTR_Core_PatchGroupDestroy(), DTTR_Core_PatchGroupHookFunction(), DTTR_Core_PatchGroupHookPointer(), DTTR_Core_PatchGroupInstallTargets(), DTTR_Core_PatchGroupPatchBytes(), DTTR_Core_PatchGroupPatchRel32Jump(), DTTR_Core_PatchGroupRelease(), dttr_hook_directdraw_create_ex_callback(), dttr_inputs_handle_device_event(), dttr_inputs_hook_dinput_poll_callback(), dttr_inputs_hooks_init(), dttr_mss_sdl_release_hooks(), DTTR_PCDOGS_Hook_DataPointer(), DTTR_PCDOGS_PatchGroup_HookDataPointer(), DTTR_PCDOGS_PatchGroup_Install(), dttr_sidecar_install_pcdogs_patch_group(), DTTR_Util_GetActiveActor(), file_open_with_mode(), install_one_target(), install_pointer_hook(), patch_group_finish_install(), patch_group_hook_symbol_function(), patch_spec_install(), require_pcdogs_call(), resolve_toc(), set_joystick_available(), target_address(), test_patch_group_target_failure_rolls_back_only_new_entries(), and test_signature_helpers_resolve_aob_patterns().

DTTR_StatusFailed()

bool DTTR_StatusFailed

(

DTTR_Status

status

)

Report whether an SDK status represents failure.

Parameters

status

Status value returned by an SDK operation.

Returns

true when status is not DTTR_OK.

Definition at line 74 of file core.c.

References DTTR_StatusOK().

DTTR_StatusName()

const char * DTTR_StatusName

(

DTTR_Status

status

)

Return a stable text token for SDK status values used by logs and tests.

Parameters

status

Status value to name.

Returns

Static string like DTTR_OK or DTTR_ERR_INVALID_ARGUMENT.

Definition at line 23 of file core.c.

References DTTR_ERR_ABI_MISMATCH, DTTR_ERR_ALREADY_INSTALLED, DTTR_ERR_HOOK_CHAIN_UNSUPPORTED, DTTR_ERR_INVALID_ARGUMENT, DTTR_ERR_MEMORY_PROTECTION, DTTR_ERR_MISSING_SYMBOL, DTTR_ERR_NOT_CALLABLE, DTTR_ERR_NOT_FOUND, DTTR_ERR_NOT_INSTALLED, DTTR_ERR_OUT_OF_MEMORY, DTTR_ERR_POLICY_MISMATCH, DTTR_ERR_PROVENANCE_UNSAFE, DTTR_ERR_READ_FAILED, DTTR_ERR_RUNTIME_UNAVAILABLE, DTTR_ERR_UNRESOLVED, DTTR_ERR_UNSUPPORTED, DTTR_ERR_UNSUPPORTED_CONTRACT, DTTR_ERR_UNSUPPORTED_LAYOUT, DTTR_ERR_WRITE_FAILED, and DTTR_OK.

Referenced by dttr_sidecar_result_detail().

DTTR_StatusOK()

bool DTTR_StatusOK

(

DTTR_Status

status

)

Report whether an SDK status represents success.

Parameters

status

Status value returned by an SDK operation.

Returns

true when status is DTTR_OK.

Definition at line 70 of file core.c.

References DTTR_OK.

Referenced by DTTR_ResultOK(), and DTTR_StatusFailed().