glib/org.gtkkn.bindings.glib/StrvBuilder

StrvBuilder

class StrvBuilder(val glibStrvBuilderPointer: <Error class: unknown class><<Error class: unknown class>>) : ProxyInstance(source)

GStrvBuilder is a helper object to build a null-terminated string arrays.

The following example shows how to build a two element array:

g_autoptr(GStrvBuilder) builder = g_strv_builder_new ();
g_strv_builder_add (builder, "hello");
g_strv_builder_add (builder, "world");

g_auto(GStrv) array = g_strv_builder_end (builder);

g_assert_true (g_strv_equal (array, (const char *[]) { "hello", "world", NULL }));

Skipped during bindings generation

method add_many: Varargs parameter is not supported

Since

2.68

Constructors

StrvBuilder

constructor()

Creates a new #GStrvBuilder with a reference count of 1. Use g_strv_builder_unref() on the returned value when no longer needed.

constructor(glibStrvBuilderPointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

glibStrvBuilderPointer

val glibStrvBuilderPointer: <Error class: unknown class><<Error class: unknown class>>

handle

open override val handle: <Error class: unknown class>

Functions

add

fun add(value: String)

Add a string to the end of the array.

addCleaner

open override fun addCleaner(cleaner: <Error class: unknown class>): Boolean

Registers a cleaner to be executed when this proxy object is garbage collected.

addv

fun addv(value: List<String>)

Appends all the strings in the given vector to the builder.

end

fun end(): List<String>

Ends the builder process and returns the constructed NULL-terminated string array. The returned value should be freed with g_strfreev() when no longer needed.

equals

open operator override fun equals(other: Any?): Boolean

Compare two proxy instances for equality. This will compare both the type of the instances, and their memory addresses.

getSimpleNameWithHandle

open fun getSimpleNameWithHandle(): String

hashCode

open override fun hashCode(): Int

ref

fun ref(): StrvBuilder

Atomically increments the reference count of @builder by one. This function is thread-safe and may be called from any thread.

removeCleaner

open override fun removeCleaner(cleaner: <Error class: unknown class>): Boolean

Removes a previously registered cleaner from this proxy object.

take

fun take(value: String)

Add a string to the end of the array. After @value belongs to the #GStrvBuilder and may no longer be modified by the caller.

unref

fun unref()

Decreases the reference count on @builder.

unrefToStrv

fun unrefToStrv(): List<String>

Decreases the reference count on the string vector builder, and returns its contents as a NULL-terminated string array.