Class NameValueArray

Hierarchy

NameValueArray

Index

Constructors

constructor

Properties

name

Methods

Constructors

constructor

new NameValueArray(): NameValueArray

- Defined in Camel-1.2.d.ts:16972
Creates a new #CamelNameValueArray. The returned pointer should be freed with camel_name_value_array_free() when no longer needed.

Returns NameValueArray

Properties

Static name

name: string

Methods

append

append(name: string, value: string): void

- Defined in Camel-1.2.d.ts:16864
Appends a new element of the name name and the value value at the end of array.

See: camel_name_value_array_set_named

Parameters
- name: string
  
  a name
- value: string
  
  a value
Returns void

clear

clear(): void

- Defined in Camel-1.2.d.ts:16868
Removes all elements of the array.

Returns void

copy

copy(): NameValueArray

- Defined in Camel-1.2.d.ts:16873
Creates a new copy of the array. The returned pointer should be freed with camel_name_value_array_free() when no longer needed.

Returns NameValueArray

equal

equal(arrayB: NameValueArray, compareType: CompareType): boolean

- Defined in Camel-1.2.d.ts:16880
Compares content of the two #CamelNameValueArray and returns whether they equal. Note this is an expensive operation for large arrays.

Parameters
- arrayB: NameValueArray
  
  the second #CamelNameValueArray
- compareType: CompareType
  
  a compare type, one of #CamelCompareType
Returns boolean

free

free(): void

- Defined in Camel-1.2.d.ts:16886
Frees the array, previously allocated by camel_name_value_array_new(), camel_name_value_array_new_sized() or camel_name_value_array_copy(). If the array is %NULL, then does nothing.

Returns void

get

get(index: number): [boolean, string, string]

- Defined in Camel-1.2.d.ts:16892
Returns the name and the value of the element at index index. Either of the out_name and out_value can be %NULL, to not return that part.

Parameters
- index: number
  
  an index
Returns [boolean, string, string]

getLength

getLength(): number

- Defined in Camel-1.2.d.ts:16893
Returns number

getName

getName(index: number): string

- Defined in Camel-1.2.d.ts:16898
Returns the name of the element at index index.

Parameters
- index: number
  
  an index
Returns string

getNamed

getNamed(compareType: CompareType, name: string): string

- Defined in Camel-1.2.d.ts:16906
Returns the value of the first element named name, or %NULL when there is no element of such name in the array. The compare_type determines how to compare the names.

Parameters
- compareType: CompareType
  
  a compare type, one of #CamelCompareType
- name: string
  
  a name
Returns string

getValue

getValue(index: number): string

- Defined in Camel-1.2.d.ts:16911
Returns the value of the element at index index.

Parameters
- index: number
  
  an index
Returns string

remove

remove(index: number): boolean

- Defined in Camel-1.2.d.ts:16916
Removes element at index index.

Parameters
- index: number
  
  an index to remove
Returns boolean

removeNamed

removeNamed(compareType: CompareType, name: string, allOccurrences: boolean): number

- Defined in Camel-1.2.d.ts:16926
Removes elements of the array with the given name. The compare_type determines hot to compare the names. If the all_occurrences is set to %TRUE, then every elements with the name are removed, otherwise only the first occurrence is removed.

Parameters
- compareType: CompareType
  
  a compare type, one of #CamelCompareType
- name: string
  
  a name to remove
- allOccurrences: boolean
  
  whether to remove all occurrences of the name
Returns number

set

set(index: number, name: string, value: string): boolean

- Defined in Camel-1.2.d.ts:16933
Sets both the name and the value of the element at index index.

Parameters
- index: number
  
  an index
- name: string
  
  a name
- value: string
  
  a value
Returns boolean

setName

setName(index: number, name: string): boolean

- Defined in Camel-1.2.d.ts:16939
Sets the name of the element at index index.

Parameters
- index: number
  
  an index
- name: string
  
  a name
Returns boolean

setNamed

setNamed(compareType: CompareType, name: string, value: string): boolean

- Defined in Camel-1.2.d.ts:16950
Finds an element named name and sets its value to value, or appends a new element, in case no such named element exists in the array yet. In case there are more elements named with name only the first occurrence is changed. The compare_type determines how to compare the names.

Parameters
- compareType: CompareType
  
  a compare type, one of #CamelCompareType
- name: string
  
  a name
- value: string
  
  a value
Returns boolean

setValue

setValue(index: number, value: string): boolean

- Defined in Camel-1.2.d.ts:16956
Sets the value of the element at index index.

Parameters
- index: number
  
  an index
- value: string
  
  a value
Returns boolean

Static new

new(): NameValueArray

- Defined in Camel-1.2.d.ts:16978
Creates a new #CamelNameValueArray. The returned pointer should be freed with camel_name_value_array_free() when no longer needed.

Returns NameValueArray

Static newSized

newSized(reserveSize: number): NameValueArray

- Defined in Camel-1.2.d.ts:16987
Creates a new #CamelNameValueArray, which has reserved reserve_size elements. This value doesn't influence the camel_name_value_array_get_length(), which returns zero on the array returned from this function. The returned pointer should be freed with camel_name_value_array_free() when no longer needed.

Parameters
- reserveSize: number
  
  an array size to reserve
Returns NameValueArray