RallyHereStringMap Struct
Opaque type and handle to a Rally Here String Map. This struct is intentionally empty because its true interface is only defined internally. Any methods which take this as the first argument can be thought of as methods on this struct.
Summary
| Kind | View | Description |
|---|---|---|
| RH_EXPORT RallyHereStatusCode | rallyhere_string_map_create(RallyHereStringMapPtr * map) | |
| RH_EXPORT void | rallyhere_string_map_destroy(RallyHereStringMapPtr map) | |
| RH_EXPORT RallyHereStatusCode | rallyhere_string_map_copy(RallyHereStringMapPtr dest, const RallyHereStringMapPtr src) | |
| RH_EXPORT void | rallyhere_string_map_clear(RallyHereStringMapPtr map) | |
| RH_EXPORT RallyHereStatusCode | rallyhere_string_map_get(RallyHereStringMapPtr map, const char * key, const char ** value, unsigned int * value_size) | |
| RH_EXPORT RallyHereStatusCode | rallyhere_string_map_set(RallyHereStringMapPtr map, const char * key, const char * value) | |
| RH_EXPORT RallyHereStatusCode | rallyhere_string_map_setn(RallyHereStringMapPtr map, const char * key, const char * value, unsigned int value_size) |
String Map
A string map structure using the assigned allocator meant to help simplify passing generic, string key-value data to and from the adapter. For those calling this from C++ there is an example wrapper which helps to manage string map lifetimes.
See also
rallyhere_string_map_create
RH_EXPORT RallyHereStatusCode rallyhere_string_map_create(RallyHereStringMapPtr * map)
Parameters
| Type | Name |
|---|---|
| RallyHereStringMapPtr * | map |
Description
Create a map of string to a string. The strings may not be null terminated in order to store binary data
rallyhere_string_map_destroy
RH_EXPORT void rallyhere_string_map_destroy(RallyHereStringMapPtr map)
Parameters
| Type | Name |
|---|---|
| RallyHereStringMapPtr | map |
Description
Destroy a map of string to a string
rallyhere_string_map_copy
RH_EXPORT RallyHereStatusCode rallyhere_string_map_copy(RallyHereStringMapPtr dest, const RallyHereStringMapPtr src)
Parameters
| Type | Name |
|---|---|
| RallyHereStringMapPtr | dest |
| const RallyHereStringMapPtr | src |
Description
Copy a RallyHereStringMap
rallyhere_string_map_clear
RH_EXPORT void rallyhere_string_map_clear(RallyHereStringMapPtr map)
Parameters
| Type | Name |
|---|---|
| RallyHereStringMapPtr | map |
Description
Clear the contents of a RallyHereStringMap
rallyhere_string_map_get
RH_EXPORT RallyHereStatusCode rallyhere_string_map_get(RallyHereStringMapPtr map, const char * key, const char ** value, unsigned int * value_size)
Parameters
| Type | Name |
|---|---|
| RallyHereStringMapPtr | map |
| const char * | key |
| const char ** | value |
| unsigned int * | value_size |
Description
Get a value form RallyHereStringMap
rallyhere_string_map_set
RH_EXPORT RallyHereStatusCode rallyhere_string_map_set(RallyHereStringMapPtr map, const char * key, const char * value)
Parameters
| Type | Name |
|---|---|
| RallyHereStringMapPtr | map |
| const char * | key |
| const char * | value |
Description
Set a value in RallyHereStringMap
rallyhere_string_map_setn
RH_EXPORT RallyHereStatusCode rallyhere_string_map_setn(RallyHereStringMapPtr map, const char * key, const char * value, unsigned int value_size)
Parameters
| Type | Name |
|---|---|
| RallyHereStringMapPtr | map |
| const char * | key |
| const char * | value |
| unsigned int | value_size |
Description
Set a value in RallyHereStringMapwith a size