API reference

kui_c.h · C API · 2/3

Browse entries grouped by interface file. Expand an entry for declarations, usage and version boundaries.

Read the related guide →

Entries retain declarations and sources. Runtime verification is recorded per entry; internal source candidates are not a promise of SDK delivery.

sdk/c/include/kui_c.h
kui_event_get_target
Declared3.61.7C / Go / Rust

Get a counted reference to the event target element and release it when done. A non-element target, such as a text node, returns NOT_FOUND. evt is valid only during the current callback and must not be stored or released.

kui_c.h
KUI_C_API KuiStatus kui_event_get_target (KuiEvent* evt, KuiElement** out);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:437

Report an issue with this entry →
kui_event_get_type
Declared3.61.7C / Go / Rust

Read the current event type name. UTF-8 output uses the caller buffer: query with NULL/0, then allocate out_len+1; the length excludes NUL. Insufficient capacity returns BUFFER_TOO_SMALL and the required length; positive capacity still receives a truncated NUL-terminated result. evt is valid only during the current callback and must not be stored or released.

kui_c.h
KUI_C_API KuiStatus kui_event_get_type (KuiEvent* evt, char* buf, size_t buf_capacity, size_t* out_len);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:434

Report an issue with this entry →
kui_event_get_type_tag
Declared3.61.7C / Go / Rust

Read the runtime tag of a borrowed event to distinguish base, mouse, wheel, pointer, keyboard, focus, input, and drag events. Access the event only while its callback remains active.

kui_c.h
KUI_C_API KuiStatus kui_event_get_type_tag(KuiEvent* event, KuiCEventTypeTag* out_tag);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:759

Report an issue with this entry →
kui_event_key_get_code
Declared3.61.7C / Go / Rust

Read the physical key code of a keyboard event, such as KeyA. Non-keyboard events return KUI_ERR_NOT_SUPPORTED. For UTF-8 output, query the length with NULL/0, then allocate need+1. The length excludes the terminating NUL; a short buffer returns BUFFER_TOO_SMALL and reports the full required length. The event is borrowed only within its callback; do not save or release it.

kui_c.h
KUI_C_API KuiStatus kui_event_key_get_code(KuiEvent* evt, char* buf, size_t buf_capacity, size_t* out_len);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:461

Report an issue with this entry →
kui_event_key_get_key
Declared3.61.7C / Go / Rust

Read the semantic key name of a keyboard event, such as a, Enter, or ArrowUp. Non-keyboard events return KUI_ERR_NOT_SUPPORTED. For UTF-8 output, query the length with NULL/0, then allocate need+1. The length excludes the terminating NUL; a short buffer returns BUFFER_TOO_SMALL and reports the full required length. The event is borrowed only within its callback; do not save or release it.

kui_c.h
KUI_C_API KuiStatus kui_event_key_get_key (KuiEvent* evt, char* buf, size_t buf_capacity, size_t* out_len);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:460

Report an issue with this entry →
kui_event_key_get_modifiers
Declared3.61.7C / Go / Rust

Read Ctrl, Shift, Alt, and Meta states from a keyboard event. Unneeded outputs may be NULL. Non-keyboard events return KUI_ERR_NOT_SUPPORTED. The event is borrowed only within its callback; do not save or release it.

kui_c.h
KUI_C_API KuiStatus kui_event_key_get_modifiers(KuiEvent* evt, int* out_ctrl, int* out_shift, int* out_alt, int* out_meta);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:463

Report an issue with this entry →
kui_event_mouse_get_button
Declared3.61.7C / Go / Rust

Read the KuiCMouseButton value of a mouse event. Non-mouse events return KUI_ERR_NOT_SUPPORTED. The event is borrowed for the current callback only; do not retain or release it.

kui_c.h
KUI_C_API KuiStatus kui_event_mouse_get_button (KuiEvent* evt, int* out_button);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:455

Report an issue with this entry →
kui_event_mouse_get_client_xy
Declared3.61.7C / Go / Rust

Read mouse client coordinates relative to the viewport; a non-mouse event returns NOT_SUPPORTED. evt is valid only during the current callback and must not be stored or released.

kui_c.h
KUI_C_API KuiStatus kui_event_mouse_get_client_xy(KuiEvent* evt, float* x, float* y);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:451

Report an issue with this entry →
kui_event_mouse_get_offset_xy
Declared3.61.7C / Go / Rust

Read mouse offset coordinates relative to the target padding box; a non-mouse event returns NOT_SUPPORTED. evt is valid only during the current callback and must not be stored or released.

kui_c.h
KUI_C_API KuiStatus kui_event_mouse_get_offset_xy(KuiEvent* evt, float* x, float* y);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:453

Report an issue with this entry →
kui_event_mouse_get_page_xy
Declared3.61.7C / Go / Rust

Read mouse page coordinates including scroll offsets; a non-mouse event returns NOT_SUPPORTED. evt is valid only during the current callback and must not be stored or released.

kui_c.h
KUI_C_API KuiStatus kui_event_mouse_get_page_xy (KuiEvent* evt, float* x, float* y);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:452

Report an issue with this entry →
kui_event_prevent_default
Declared3.61.7C / Go / Rust

Prevent the default action during the current event callback. evt is valid only during the current callback and must not be stored or released.

kui_c.h
KUI_C_API KuiStatus kui_event_prevent_default (KuiEvent* evt);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:439

Report an issue with this entry →
kui_event_stop_propagation
Declared3.61.7C / Go / Rust

Stop further propagation during the current event callback. evt is valid only during the current callback and must not be stored or released.

kui_c.h
KUI_C_API KuiStatus kui_event_stop_propagation(KuiEvent* evt);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:440

Report an issue with this entry →
kui_extension_result_get_count
Declared3.61.7C / Go / Rust

Read the number of values actually returned by an extension invocation for indexed access.

kui_c.h
KUI_C_API KuiStatus kui_extension_result_get_count(KuiExtensionResult* result, size_t* out_count);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:887

Report an issue with this entry →
kui_extension_result_get_error
Declared3.61.7C / Go / Rust

Read the error text stored in an extension invocation result. For UTF-8 output, query the length with NULL/0, then allocate need+1. The length excludes the terminating NUL; a short buffer returns BUFFER_TOO_SMALL and reports the full required length.

kui_c.h
KUI_C_API KuiStatus kui_extension_result_get_error(KuiExtensionResult* result, char* buf, size_t capacity, size_t* out_len);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:896

Report an issue with this entry →
kui_extension_result_get_status
Declared3.61.7C / Go / Rust

Read the extension method invocation status code. It is distinct from the KuiStatus returned by the result accessor itself.

kui_c.h
KUI_C_API KuiStatus kui_extension_result_get_status(KuiExtensionResult* result, int* out_status);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:885

Report an issue with this entry →
kui_extension_result_get_string
Declared3.61.7C / Go / Rust

Copy an extension string result by index. An out-of-range index returns NOT_FOUND; a non-string result returns NOT_SUPPORTED. For UTF-8 output, query the length with NULL/0, then allocate need+1. The length excludes the terminating NUL; a short buffer returns BUFFER_TOO_SMALL and reports the full required length.

kui_c.h
KUI_C_API KuiStatus kui_extension_result_get_string(KuiExtensionResult* result, size_t index, char* buf, size_t capacity, size_t* out_len);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:892

Report an issue with this entry →
kui_extension_result_get_value
Declared3.61.7C / Go / Rust

Read an extension result type and scalar fields by index. An out-of-range index returns NOT_FOUND. For strings, string_len reports the length and string_value is NULL; copy the text with get_string.

kui_c.h
KUI_C_API KuiStatus kui_extension_result_get_value(KuiExtensionResult* result, size_t index, KuiCExtensionValue* out_value);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:889

Report an issue with this entry →
kui_extension_result_release
Declared3.61.7C / Go / Rust

Release an extension invocation result handle exactly once. Read any needed values and error text before release.

kui_c.h
KUI_C_API KuiStatus kui_extension_result_release(KuiExtensionResult* result);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:884

Report an issue with this entry →
kui_get_version
Declared3.61.7C / Go / Rust

Read the loaded library runtime version, which can differ from the compile-time version macros.

kui_c.h
KUI_C_API KuiVersion kui_get_version(void);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:101

Report an issue with this entry →
kui_http_client_cancel_all
Declared3.61.7C / Go / Rust

Cancel all pending asynchronous requests belonging to this client.

kui_c.h
KUI_C_API KuiStatus kui_http_client_cancel_all(KuiHttpClient* client);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:836

Report an issue with this entry →
kui_http_client_create
Declared3.61.7C / Go / Rust

Create an HTTP client handle for synchronous or asynchronous requests. Release it with kui_http_client_release when finished.

kui_c.h
KUI_C_API KuiStatus kui_http_client_create(KuiHttpClient** out_client);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:824

Report an issue with this entry →
kui_http_client_fetch_async
Declared3.61.7C / Go / Rust

Fetch a URL asynchronously and call back on completion. The callback may run on a worker thread and must not mutate the DOM directly. It owns and must release the response handle. Allocation failure may pass NULL; the callback must not throw.

kui_c.h
KUI_C_API KuiStatus kui_http_client_fetch_async(KuiHttpClient* client, const char* url, size_t len, double timeout_seconds, KuiHttpResponseFn fn, void* user_data);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:832

Report an issue with this entry →
kui_http_client_fetch_sync
Declared3.61.7C / Go / Rust

Fetch a URL synchronously, blocking until completion or timeout. Release the returned response handle separately. KUI_OK means the ABI call completed; inspect the response for HTTP status and network errors.

kui_c.h
KUI_C_API KuiStatus kui_http_client_fetch_sync(KuiHttpClient* client, const char* url, size_t len, double timeout_seconds, KuiHttpResponse** out_response);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:828

Report an issue with this entry →
kui_http_client_release
Declared3.61.7C / Go / Rust

Release and destroy an HTTP client handle exactly once. Do not start further requests through the released handle.

kui_c.h
KUI_C_API KuiStatus kui_http_client_release(KuiHttpClient* client);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:825

Report an issue with this entry →
kui_http_client_set_user_agent
Declared3.61.7C / Go / Rust

Set the HTTP client User-Agent string. The UTF-8 pointer must be non-NULL; zero len reads through the NUL terminator.

kui_c.h
KUI_C_API KuiStatus kui_http_client_set_user_agent(KuiHttpClient* client, const char* user_agent, size_t len);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:826

Report an issue with this entry →
kui_http_response_get_body
Declared3.61.7C / Go / Rust

Copy raw response body bytes, which may contain NUL. Query the required byte count, then allocate need+1 bytes. The current bridge also writes a terminating NUL; the body length excludes that terminator.

kui_c.h
KUI_C_API KuiStatus kui_http_response_get_body(KuiHttpResponse* response, uint8_t* buf, size_t capacity, size_t* out_len);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:840

Report an issue with this entry →
kui_http_response_get_content_type
Declared3.61.7C / Go / Rust

Read the HTTP response Content-Type string. For UTF-8 output, query the length with NULL/0, then allocate need+1. The length excludes the terminating NUL; a short buffer returns BUFFER_TOO_SMALL and reports the full required length.

kui_c.h
KUI_C_API KuiStatus kui_http_response_get_content_type(KuiHttpResponse* response, char* buf, size_t capacity, size_t* out_len);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:843

Report an issue with this entry →
kui_http_response_get_error
Declared3.61.7C / Go / Rust

Read the HTTP response network error string to inspect and display the reason for a failed request. For UTF-8 output, query the length with NULL/0, then allocate need+1. The length excludes the terminating NUL; a short buffer returns BUFFER_TOO_SMALL and reports the full required length.

kui_c.h
KUI_C_API KuiStatus kui_http_response_get_error(KuiHttpResponse* response, char* buf, size_t capacity, size_t* out_len);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:846

Report an issue with this entry →
kui_http_response_get_status
Declared3.61.7C / Go / Rust

Read the HTTP response status code. Check the error text separately for transport failures.

kui_c.h
KUI_C_API KuiStatus kui_http_response_get_status(KuiHttpResponse* response, int* out_status_code);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:838

Report an issue with this entry →
kui_http_response_release
Declared3.61.7C / Go / Rust

Release an HTTP response handle exactly once. The caller owns responses returned synchronously and responses received by asynchronous callbacks.

kui_c.h
KUI_C_API KuiStatus kui_http_response_release(KuiHttpResponse* response);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:837

Report an issue with this entry →
kui_lottie_get_complete
Declared3.61.7C / Go / Rust

Query whether a Lottie resource has finished loading as 0 or 1. complete checks LoadState::Complete, not whether playback has ended. Non-Lottie elements return NOT_SUPPORTED.

kui_c.h
KUI_C_API KuiStatus kui_lottie_get_complete(KuiElement* element, int* out_complete);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:796

Report an issue with this entry →
kui_lottie_get_natural_size
Declared3.61.7C / Go / Rust

Read a Lottie animation natural width and height. One output may be omitted, but not both. Non-Lottie elements return NOT_SUPPORTED.

kui_c.h
KUI_C_API KuiStatus kui_lottie_get_natural_size(KuiElement* element, float* out_width, float* out_height);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:797

Report an issue with this entry →
kui_lottie_pause
Declared3.61.7C / Go / Rust

Pause animation of a Lottie element on the main thread. Non-Lottie elements return NOT_SUPPORTED.

kui_c.h
KUI_C_API KuiStatus kui_lottie_pause(KuiElement* element);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:795

Report an issue with this entry →
kui_lottie_play
Declared3.61.7C / Go / Rust

Request playback of a Lottie element on the main thread. Non-Lottie elements return NOT_SUPPORTED.

kui_c.h
KUI_C_API KuiStatus kui_lottie_play(KuiElement* element);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:794

Report an issue with this entry →
kui_lottie_set_src
Declared3.61.7C / Go / Rust

Set a Lottie element source on the main thread. src must be non-NULL; non-Lottie elements return NOT_SUPPORTED.

kui_c.h
KUI_C_API KuiStatus kui_lottie_set_src(KuiElement* element, const char* src, size_t len);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:793

Report an issue with this entry →
kui_media_get_current_time
Declared3.61.7C / Go / Rust

Read a media element current playback time in seconds. Non-media elements return NOT_SUPPORTED.

kui_c.h
KUI_C_API KuiStatus kui_media_get_current_time(KuiElement* element, double* out_seconds);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:782

Report an issue with this entry →
kui_media_get_duration
Declared3.61.7C / Go / Rust

Read the media resource duration in seconds. Non-media elements return NOT_SUPPORTED.

kui_c.h
KUI_C_API KuiStatus kui_media_get_duration(KuiElement* element, double* out_seconds);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:783

Report an issue with this entry →
kui_media_get_muted
Declared3.61.7C / Go / Rust

Read whether a media element is muted as 0 or 1. Non-media elements return NOT_SUPPORTED.

kui_c.h
KUI_C_API KuiStatus kui_media_get_muted(KuiElement* element, int* out_muted);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:787

Report an issue with this entry →
kui_media_get_network_state
Declared3.61.7C / Go / Rust

Read the integer network-state enum value of a media element. Non-media elements return NOT_SUPPORTED.

kui_c.h
KUI_C_API KuiStatus kui_media_get_network_state(KuiElement* element, int* out_state);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:790

Report an issue with this entry →
kui_media_get_paused
Declared3.61.7C / Go / Rust

Read whether a media element is paused as 0 or 1. Non-media elements return NOT_SUPPORTED.

kui_c.h
KUI_C_API KuiStatus kui_media_get_paused(KuiElement* element, int* out_paused);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:788

Report an issue with this entry →
kui_media_get_ready_state
Declared3.61.7C / Go / Rust

Read the integer ready-state enum value of a media element. Non-media elements return NOT_SUPPORTED.

kui_c.h
KUI_C_API KuiStatus kui_media_get_ready_state(KuiElement* element, int* out_state);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:789

Report an issue with this entry →
kui_media_get_volume
Declared3.61.7C / Go / Rust

Read a media element current volume. Non-media elements return NOT_SUPPORTED.

kui_c.h
KUI_C_API KuiStatus kui_media_get_volume(KuiElement* element, float* out_volume);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:785

Report an issue with this entry →
kui_media_is_available
Declared3.61.7C / Go / Rust

Query whether media capability is available for a media element, returning 0 or 1. Non-media elements return NOT_SUPPORTED. Availability does not establish successful resource playback.

kui_c.h
KUI_C_API KuiStatus kui_media_is_available(KuiElement* element, int* out_available);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:791

Report an issue with this entry →
kui_media_pause
Declared3.61.7C / Go / Rust

Pause a media element on the main thread. Non-media elements return NOT_SUPPORTED.

kui_c.h
KUI_C_API KuiStatus kui_media_pause(KuiElement* element);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:778

Report an issue with this entry →
kui_media_play
Declared3.61.7C / Go / Rust

Request playback of a media element on the main thread. A non-media element returns NOT_SUPPORTED; actual playback also depends on the media backend and resource state.

kui_c.h
KUI_C_API KuiStatus kui_media_play(KuiElement* element);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:777

Report an issue with this entry →
kui_media_set_controls
Declared3.61.7C / Go / Rust

Set whether a media element displays playback controls on the main thread. A nonzero enabled flag enables them. Non-media elements return NOT_SUPPORTED.

kui_c.h
KUI_C_API KuiStatus kui_media_set_controls(KuiElement* element, int enabled);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:780

Report an issue with this entry →
kui_media_set_current_time
Declared3.61.7C / Go / Rust

Set a media element playback position in seconds on the main thread. Non-media elements return NOT_SUPPORTED.

kui_c.h
KUI_C_API KuiStatus kui_media_set_current_time(KuiElement* element, double seconds);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:781

Report an issue with this entry →
kui_media_set_muted
Declared3.61.7C / Go / Rust

Set a media element muted state on the main thread. A nonzero muted flag mutes it. Non-media elements return NOT_SUPPORTED.

kui_c.h
KUI_C_API KuiStatus kui_media_set_muted(KuiElement* element, int muted);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:786

Report an issue with this entry →
kui_media_set_src
Declared3.61.7C / Go / Rust

Set a media element source on the main thread. src must be non-NULL, and non-media elements return NOT_SUPPORTED.

kui_c.h
KUI_C_API KuiStatus kui_media_set_src(KuiElement* element, const char* src, size_t len);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:779

Report an issue with this entry →
kui_media_set_volume
Declared3.61.7C / Go / Rust

Set a media element volume on the main thread. Non-media elements return NOT_SUPPORTED. Value handling follows the media element implementation.

kui_c.h
KUI_C_API KuiStatus kui_media_set_volume(KuiElement* element, float volume);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:784

Report an issue with this entry →
kui_platform_clear_timer
Declared3.61.7C / Go / Rust

Clear a timeout or interval task by timer ID.

kui_c.h
KUI_C_API KuiStatus kui_platform_clear_timer (KuiTimerId id);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:179

Report an issue with this entry →
kui_platform_get_clipboard_text
Declared3.61.7C / Go / Rust

Copy text from the system clipboard into a caller-owned buffer. For UTF-8 output, query the length with NULL/0, then allocate need+1. The length excludes the terminating NUL; a short buffer returns BUFFER_TOO_SMALL and reports the full required length.

kui_c.h
KUI_C_API KuiStatus kui_platform_get_clipboard_text(char* buf, size_t capacity, size_t* out_len);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:702

Report an issue with this entry →
kui_platform_get_monitor
Declared3.61.7C / Go / Rust

Read a monitor bounds, work area, scale, and primary flag by index. Write its name into a caller-owned UTF-8 buffer. A missing index returns NOT_FOUND. For UTF-8 output, query the length with NULL/0, then allocate need+1. The length excludes the terminating NUL; a short buffer returns BUFFER_TOO_SMALL and reports the full required length.

kui_c.h
KUI_C_API KuiStatus kui_platform_get_monitor(size_t index, KuiCMonitorInfo* out_monitor, char* name_buf, size_t name_capacity, size_t* out_name_len);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:696

Report an issue with this entry →
kui_platform_get_monitor_count
Declared3.61.7C / Go / Rust

Read the current monitor count to determine the range for indexed monitor queries.

kui_c.h
KUI_C_API KuiStatus kui_platform_get_monitor_count(size_t* out_count);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:695

Report an issue with this entry →
kui_platform_get_os_name
Declared3.61.7C / Go / Rust

Read the current operating system name into a caller-owned buffer. For UTF-8 output, query the length with NULL/0, then allocate need+1. The length excludes the terminating NUL; a short buffer returns BUFFER_TOO_SMALL and reports the full required length.

kui_c.h
KUI_C_API KuiStatus kui_platform_get_os_name(char* buf, size_t capacity, size_t* out_len);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:706

Report an issue with this entry →
kui_platform_get_os_version
Declared3.61.7C / Go / Rust

Read the current operating system version string into a caller-owned buffer. For UTF-8 output, query the length with NULL/0, then allocate need+1. The length excludes the terminating NUL; a short buffer returns BUFFER_TOO_SMALL and reports the full required length.

kui_c.h
KUI_C_API KuiStatus kui_platform_get_os_version(char* buf, size_t capacity, size_t* out_len);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:707

Report an issue with this entry →
kui_platform_get_primary_monitor
Declared3.61.7C / Go / Rust

Read the primary monitor bounds, work area, scale and primary flag.

kui_c.h
KUI_C_API KuiStatus kui_platform_get_primary_monitor(KuiCMonitorInfo* out_monitor);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:190

Report an issue with this entry →
kui_platform_get_primary_monitor_physical_size
Declared3.61.7C / Go / Rust

Read the primary monitor physical size. Either width or height may be omitted, but both outputs cannot be NULL.

kui_c.h
KUI_C_API KuiStatus kui_platform_get_primary_monitor_physical_size(float* out_width, float* out_height);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:700

Report an issue with this entry →
kui_platform_has_clipboard_text
Declared3.61.7C / Go / Rust

Check whether the system clipboard currently contains text and return the result as an integer.

kui_c.h
KUI_C_API KuiStatus kui_platform_has_clipboard_text(int* out_has_text);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:705

Report an issue with this entry →
kui_platform_init
Declared3.61.7C / Go / Rust

Initialize process-wide platform services before creating GUI windows and running the event loop.

kui_c.h
KUI_C_API KuiStatus kui_platform_init(void);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:153

Report an issue with this entry →
kui_platform_open_file_dialog
Declared3.61.7C / Go / Rust

Open a file picker with title, default path, filters, and multiple-selection options. Supply a valid output buffer for this one-shot operation; the header recommends 32768 bytes on Windows. Cancellation returns NOT_FOUND. Do not probe with an empty buffer and then reopen.

kui_c.h
KUI_C_API KuiStatus kui_platform_open_file_dialog(const KuiCFileDialogOptions* options, char* buf, size_t capacity, size_t* out_len);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:721

Report an issue with this entry →
kui_platform_poll_events
Declared3.61.7C / Go / Rust

Process pending events and return immediately, for embedding in a host that owns its event loop.

kui_c.h
KUI_C_API KuiStatus kui_platform_poll_events(void);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:162

Report an issue with this entry →
kui_platform_quit
Declared3.61.7C / Go / Rust

Request that the platform event loop quit with the supplied exit code.

kui_c.h
KUI_C_API KuiStatus kui_platform_quit(int exit_code);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:158

Report an issue with this entry →
kui_platform_request_idle
Declared3.61.7C / Go / Rust

Schedule a callback once when the event loop next becomes idle. It runs on the main thread; KUI does not free user_data.

kui_c.h
KUI_C_API KuiStatus kui_platform_request_idle(KuiTaskFn fn, void* user_data);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:181

Report an issue with this entry →
kui_platform_run
Declared3.61.7C / Go / Rust

Run the blocking platform event loop until quit is requested, returning the exit code through the output parameter.

kui_c.h
KUI_C_API KuiStatus kui_platform_run(int* out_exit_code);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:157

Report an issue with this entry →
kui_platform_save_file_dialog
Declared3.61.7C / Go / Rust

Open a save-file dialog and return the chosen path. Supply a valid output buffer in this one-shot operation; 32768 bytes is recommended on Windows. Cancellation returns NOT_FOUND. The returned path does not itself save file contents.

kui_c.h
KUI_C_API KuiStatus kui_platform_save_file_dialog(const KuiCFileDialogOptions* options, char* buf, size_t capacity, size_t* out_len);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:724

Report an issue with this entry →
kui_platform_select_folder_dialog
Declared3.61.7C / Go / Rust

Open a folder picker with a title and copy the selected path. Provide a valid buffer for the one-shot operation; 32768 bytes is recommended on Windows. Cancellation returns NOT_FOUND.

kui_c.h
KUI_C_API KuiStatus kui_platform_select_folder_dialog(const char* title, size_t title_len, char* buf, size_t capacity, size_t* out_len);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:727

Report an issue with this entry →
kui_platform_set_clipboard_text
Declared3.61.7C / Go / Rust

Write UTF-8 text to the system clipboard. text must be non-NULL; a zero len reads through the NUL terminator.

kui_c.h
KUI_C_API KuiStatus kui_platform_set_clipboard_text(const char* text, size_t len);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:704

Report an issue with this entry →
kui_platform_set_f12_devtools_enabled
Declared3.61.7C / Go / Rust

Enable or disable the platform behavior that opens DevTools with F12.

kui_c.h
KUI_C_API KuiStatus kui_platform_set_f12_devtools_enabled(int enabled);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:182

Report an issue with this entry →
kui_platform_set_interval
Declared3.61.7C / Go / Rust

Schedule a repeating callback at a millisecond interval and return its ID; clear it explicitly. Callbacks run on the main thread only while the event loop is active. The caller owns user_data and must keep it alive at least until the timer is cleared.

kui_c.h
KUI_C_API KuiStatus kui_platform_set_interval(KuiTaskFn fn, void* user_data, uint32_t interval_ms, KuiTimerId* out_id);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:177

Report an issue with this entry →
kui_platform_set_timeout
Declared3.61.7C / Go / Rust

Schedule a one-shot callback after a millisecond delay and return its timer ID. An active event loop runs it on the main thread. KUI does not free user_data; keep it valid while waiting and during the callback. The timer needs no clearing after it fires.

kui_c.h
KUI_C_API KuiStatus kui_platform_set_timeout (KuiTaskFn fn, void* user_data, uint32_t delay_ms, KuiTimerId* out_id);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:175

Report an issue with this entry →
kui_platform_shutdown
Declared3.61.7C / Go / Rust

Shut down platform services after the event loop ends and handles have been released in the standard lifecycle.

kui_c.h
KUI_C_API KuiStatus kui_platform_shutdown(void);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:154

Report an issue with this entry →
kui_platform_wait_events
Declared3.61.7C / Go / Rust

Wait for an event or timeout; a negative timeout_seconds waits indefinitely.

kui_c.h
KUI_C_API KuiStatus kui_platform_wait_events(double timeout_seconds);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:164

Report an issue with this entry →
kui_script_engine_bind_document
Declared3.61.7C / Go / Rust

Bind a document to a script engine on the main thread so scripts can operate on it. Keep the document valid while the binding is used. Returns NOT_SUPPORTED when scripting is disabled.

kui_c.h
KUI_C_API KuiStatus kui_script_engine_bind_document(KuiScriptEngine* engine, KuiDocument* document);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:806

Report an issue with this entry →
kui_script_engine_create
Declared3.61.7C / Go / Rust

Create a Lua script engine handle to be released with kui_script_engine_release. Returns NOT_SUPPORTED when scripting is disabled in the build or an engine cannot be created.

kui_c.h
KUI_C_API KuiStatus kui_script_engine_create(KuiScriptEngine** out_engine);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:804

Report an issue with this entry →
kui_script_engine_eval
Declared3.61.7C / Go / Rust

Evaluate Lua source with an optional source name; NULL uses <eval>. Check out_success for script success and read errors from the caller buffer. Retrying evaluates the source again, so a side-effecting script is not a harmless two-call query. Returns NOT_SUPPORTED when scripting is disabled.

kui_c.h
KUI_C_API KuiStatus kui_script_engine_eval(KuiScriptEngine* engine, const char* code, size_t code_len, const char* source, size_t source_len, int* out_success, char* error_buf, size_t error_capacity, size_t* out_error_len);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:809

Report an issue with this entry →
kui_script_engine_execute_scripts
Declared3.61.7C / Go / Rust

Execute scripts in the bound document on the main thread. Requires a valid engine and relevant document binding. Returns NOT_SUPPORTED when scripting is disabled.

kui_c.h
KUI_C_API KuiStatus kui_script_engine_execute_scripts(KuiScriptEngine* engine);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:815

Report an issue with this entry →
kui_script_engine_release
Declared3.61.7C / Go / Rust

Release and destroy a script engine handle exactly once. Detach any window borrowing the engine and stop further calls before destruction.

kui_c.h
KUI_C_API KuiStatus kui_script_engine_release(KuiScriptEngine* engine);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:805

Report an issue with this entry →
kui_script_engine_set_error_handler
Declared3.61.7C / Go / Rust

Set a script error callback receiving error text, source, line number, and user_data. A NULL fn clears it. Callback text is temporarily borrowed and must be copied if needed later. Returns NOT_SUPPORTED when scripting is disabled.

kui_c.h
KUI_C_API KuiStatus kui_script_engine_set_error_handler(KuiScriptEngine* engine, KuiScriptErrorFn fn, void* user_data);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:816

Report an issue with this entry →
kui_script_engine_unbind_document
Declared3.61.7C / Go / Rust

Unbind the document from a script engine on the main thread. Returns NOT_SUPPORTED when scripting is disabled.

kui_c.h
KUI_C_API KuiStatus kui_script_engine_unbind_document(KuiScriptEngine* engine);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:808

Report an issue with this entry →
Browse this reference type →