Gjsify LogoGjsify Logo

Hierarchy

  • NamedParameters

Index

Constructors

  • Creates a new instance of an #ENamedParameters. This should be freed with e_named_parameters_free(), when no longer needed. Names are compared case insensitively.

    The structure is not thread safe, if the caller requires thread safety, then it should provide it on its own.

    Returns NamedParameters

Properties

name: string

Methods

  • clear(): void
  • count(): number
  • exists(name: string): boolean
  • free(): void
  • Frees an instance of #ENamedParameters, previously allocated with e_named_parameters_new(). Function does nothing, if parameters is %NULL.

    Returns void

  • get(name: string): string
  • Returns current value of a parameter with name name. If not such exists, then returns %NULL.

    Parameters

    • name: string

      name of a parameter to get

    Returns string

  • get_name(index: number): string
  • Creates a new instance of an #ENamedParameters, with initial content being taken from parameters. This should be freed with e_named_parameters_free(), when no longer needed. Names are compared case insensitively.

    The structure is not thread safe, if the caller requires thread safety, then it should provide it on its own.

    Returns NamedParameters

  • set(name: string, value: string): void
  • Sets parameter named name to value value. If value is NULL, then the parameter is removed. value can be an empty string.

    Note: There is a restriction on parameter names, it cannot be empty or contain a colon character (':'), otherwise it can be pretty much anything.

    Parameters

    • name: string

      name of a parameter to set

    • value: string

      value to set, or %NULL to unset

    Returns void

  • test(name: string, value: string, case_sensitively: boolean): boolean
  • Compares current value of parameter named name with given value and returns whether they are equal, either case sensitively or insensitively, based on case_sensitively argument. Function returns %FALSE, if no such parameter exists.

    Parameters

    • name: string

      name of a parameter to test

    • value: string

      value to test

    • case_sensitively: boolean

      whether to compare case sensitively

    Returns boolean

  • to_string(): string
  • to_strv(): string[]
  • Creates a new instance of an #ENamedParameters. This should be freed with e_named_parameters_free(), when no longer needed. Names are compared case insensitively.

    The structure is not thread safe, if the caller requires thread safety, then it should provide it on its own.

    Returns NamedParameters

  • Creates a new instance of an #ENamedParameters, with initial content being taken from str. This should be freed with e_named_parameters_free(), when no longer needed. Names are compared case insensitively.

    The str should be created with e_named_parameters_to_string(), to be properly encoded.

    The structure is not thread safe, if the caller requires thread safety, then it should provide it on its own.

    Parameters

    • str: string

      a string to be used as a content of a newly created #ENamedParameters

    Returns NamedParameters

  • Creates a new instance of an #ENamedParameters, with initial content being taken from strv. This should be freed with e_named_parameters_free(), when no longer needed. Names are compared case insensitively.

    The structure is not thread safe, if the caller requires thread safety, then it should provide it on its own.

    Parameters

    • strv: string

      NULL-terminated string array to be used as a content of a newly created #ENamedParameters

    Returns NamedParameters

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method