Table of Contents

Class OptionContext

Namespace
GLib.Internal
Assembly
GLib-2.0.dll
public class OptionContext
Inheritance
OptionContext
Inherited Members

Methods

AddGroup(OptionContextHandle, OptionGroupUnownedHandle)

Calls native method g_option_context_add_group. Version: 2.6

[Version("2.6")]
public static extern void AddGroup(OptionContextHandle context, OptionGroupUnownedHandle group)

Parameters

context OptionContextHandle

Transfer ownership: None Nullable: False

group OptionGroupUnownedHandle

Transfer ownership: Full Nullable: False

AddMainEntries(OptionContextHandle, OptionEntryArrayHandle, NullableUtf8StringHandle)

Calls native method g_option_context_add_main_entries. Version: 2.6

[Version("2.6")]
public static extern void AddMainEntries(OptionContextHandle context, OptionEntryArrayHandle entries, NullableUtf8StringHandle translationDomain)

Parameters

context OptionContextHandle

Transfer ownership: None Nullable: False

entries OptionEntryArrayHandle

Transfer ownership: None Nullable: False

translationDomain NullableUtf8StringHandle

Transfer ownership: None Nullable: True

Free(OptionContextUnownedHandle)

Calls native method g_option_context_free. Version: 2.6

[Version("2.6")]
public static extern void Free(OptionContextUnownedHandle context)

Parameters

context OptionContextUnownedHandle

Transfer ownership: Full Nullable: False

GetDescription(OptionContextHandle)

Calls native method g_option_context_get_description. Version: 2.12

[Version("2.12")]
public static extern NonNullableUtf8StringUnownedHandle GetDescription(OptionContextHandle context)

Parameters

context OptionContextHandle

Transfer ownership: None Nullable: False

Returns

NonNullableUtf8StringUnownedHandle

Transfer ownership: None Nullable: False

GetHelp(OptionContextHandle, bool, OptionGroupHandle)

Calls native method g_option_context_get_help. Version: 2.14

[Version("2.14")]
public static extern NonNullableUtf8StringOwnedHandle GetHelp(OptionContextHandle context, bool mainHelp, OptionGroupHandle group)

Parameters

context OptionContextHandle

Transfer ownership: None Nullable: False

mainHelp bool

Transfer ownership: None Nullable: False

group OptionGroupHandle

Transfer ownership: None Nullable: True

Returns

NonNullableUtf8StringOwnedHandle

Transfer ownership: Full Nullable: False

GetHelpEnabled(OptionContextHandle)

Calls native method g_option_context_get_help_enabled. Version: 2.6

[Version("2.6")]
public static extern bool GetHelpEnabled(OptionContextHandle context)

Parameters

context OptionContextHandle

Transfer ownership: None Nullable: False

Returns

bool

Transfer ownership: None Nullable: False

GetIgnoreUnknownOptions(OptionContextHandle)

Calls native method g_option_context_get_ignore_unknown_options. Version: 2.6

[Version("2.6")]
public static extern bool GetIgnoreUnknownOptions(OptionContextHandle context)

Parameters

context OptionContextHandle

Transfer ownership: None Nullable: False

Returns

bool

Transfer ownership: None Nullable: False

GetMainGroup(OptionContextHandle)

Calls native method g_option_context_get_main_group. Version: 2.6

[Version("2.6")]
public static extern OptionGroupUnownedHandle GetMainGroup(OptionContextHandle context)

Parameters

context OptionContextHandle

Transfer ownership: None Nullable: False

Returns

OptionGroupUnownedHandle

Transfer ownership: None Nullable: False

GetStrictPosix(OptionContextHandle)

Calls native method g_option_context_get_strict_posix. Version: 2.44

[Version("2.44")]
public static extern bool GetStrictPosix(OptionContextHandle context)

Parameters

context OptionContextHandle

Transfer ownership: None Nullable: False

Returns

bool

Transfer ownership: None Nullable: False

GetSummary(OptionContextHandle)

Calls native method g_option_context_get_summary. Version: 2.12

[Version("2.12")]
public static extern NonNullableUtf8StringUnownedHandle GetSummary(OptionContextHandle context)

Parameters

context OptionContextHandle

Transfer ownership: None Nullable: False

Returns

NonNullableUtf8StringUnownedHandle

Transfer ownership: None Nullable: False

New(NullableUtf8StringHandle)

Calls native function g_option_context_new. Version: 2.6

[Version("2.6")]
public static extern OptionContextOwnedHandle New(NullableUtf8StringHandle parameterString)

Parameters

parameterString NullableUtf8StringHandle

Transfer ownership: None Nullable: True

Returns

OptionContextOwnedHandle

Transfer ownership: Full Nullable: False

Parse(OptionContextHandle, ref int, string[], out ErrorOwnedHandle)

Calls native method g_option_context_parse. Version: 2.6

[Version("2.6")]
public static extern bool Parse(OptionContextHandle context, ref int argc, string[] argv, out ErrorOwnedHandle error)

Parameters

context OptionContextHandle

Transfer ownership: None Nullable: False

argc int

Transfer ownership: Full Nullable: False

argv string[]

Transfer ownership: Full Nullable: False

error ErrorOwnedHandle

Returns

bool

Transfer ownership: None Nullable: False

SetDescription(OptionContextHandle, NullableUtf8StringHandle)

Calls native method g_option_context_set_description. Version: 2.12

[Version("2.12")]
public static extern void SetDescription(OptionContextHandle context, NullableUtf8StringHandle description)

Parameters

context OptionContextHandle

Transfer ownership: None Nullable: False

description NullableUtf8StringHandle

Transfer ownership: None Nullable: True

SetHelpEnabled(OptionContextHandle, bool)

Calls native method g_option_context_set_help_enabled. Version: 2.6

[Version("2.6")]
public static extern void SetHelpEnabled(OptionContextHandle context, bool helpEnabled)

Parameters

context OptionContextHandle

Transfer ownership: None Nullable: False

helpEnabled bool

Transfer ownership: None Nullable: False

SetIgnoreUnknownOptions(OptionContextHandle, bool)

Calls native method g_option_context_set_ignore_unknown_options. Version: 2.6

[Version("2.6")]
public static extern void SetIgnoreUnknownOptions(OptionContextHandle context, bool ignoreUnknown)

Parameters

context OptionContextHandle

Transfer ownership: None Nullable: False

ignoreUnknown bool

Transfer ownership: None Nullable: False

SetMainGroup(OptionContextHandle, OptionGroupUnownedHandle)

Calls native method g_option_context_set_main_group. Version: 2.6

[Version("2.6")]
public static extern void SetMainGroup(OptionContextHandle context, OptionGroupUnownedHandle group)

Parameters

context OptionContextHandle

Transfer ownership: None Nullable: False

group OptionGroupUnownedHandle

Transfer ownership: Full Nullable: False

SetStrictPosix(OptionContextHandle, bool)

Calls native method g_option_context_set_strict_posix. Version: 2.44

[Version("2.44")]
public static extern void SetStrictPosix(OptionContextHandle context, bool strictPosix)

Parameters

context OptionContextHandle

Transfer ownership: None Nullable: False

strictPosix bool

Transfer ownership: None Nullable: False

SetSummary(OptionContextHandle, NullableUtf8StringHandle)

Calls native method g_option_context_set_summary. Version: 2.12

[Version("2.12")]
public static extern void SetSummary(OptionContextHandle context, NullableUtf8StringHandle summary)

Parameters

context OptionContextHandle

Transfer ownership: None Nullable: False

summary NullableUtf8StringHandle

Transfer ownership: None Nullable: True

SetTranslateFunc(OptionContextHandle, TranslateFunc, IntPtr, DestroyNotify)

Calls native method g_option_context_set_translate_func. Version: 2.12

[Version("2.12")]
public static extern void SetTranslateFunc(OptionContextHandle context, TranslateFunc func, IntPtr data, DestroyNotify destroyNotify)

Parameters

context OptionContextHandle

Transfer ownership: None Nullable: False

func TranslateFunc

Transfer ownership: None Nullable: True

data IntPtr

Transfer ownership: None Nullable: True

destroyNotify DestroyNotify

Transfer ownership: None Nullable: True

SetTranslationDomain(OptionContextHandle, NonNullableUtf8StringHandle)

Calls native method g_option_context_set_translation_domain. Version: 2.12

[Version("2.12")]
public static extern void SetTranslationDomain(OptionContextHandle context, NonNullableUtf8StringHandle domain)

Parameters

context OptionContextHandle

Transfer ownership: None Nullable: False

domain NonNullableUtf8StringHandle

Transfer ownership: None Nullable: False

Edit this page