![]() |
Delta Chat Core C-API
|
#include <deltachat.h>
Public Member Functions | |
double | dc_array_get_accuracy (const dc_array_t *array, size_t index) |
Return the accuracy of the item at the given index. More... | |
uint32_t | dc_array_get_chat_id (const dc_array_t *array, size_t index) |
Return the chat-id of the item at the given index. More... | |
size_t | dc_array_get_cnt (const dc_array_t *array) |
Find out the number of items in an array. More... | |
uint32_t | dc_array_get_contact_id (const dc_array_t *array, size_t index) |
Return the contact-id of the item at the given index. More... | |
uint32_t | dc_array_get_id (const dc_array_t *array, size_t index) |
Get the item at the given index as an ID. More... | |
double | dc_array_get_latitude (const dc_array_t *array, size_t index) |
Return the latitude of the item at the given index. More... | |
double | dc_array_get_longitude (const dc_array_t *array, size_t index) |
Return the longitude of the item at the given index. More... | |
char * | dc_array_get_marker (const dc_array_t *array, size_t index) |
Return the marker-character of the item at the given index. More... | |
uint32_t | dc_array_get_msg_id (const dc_array_t *array, size_t index) |
Return the message-id of the item at the given index. More... | |
void * | dc_array_get_ptr (const dc_array_t *array, size_t index) |
Get the item at the given index as an ID. More... | |
const uintptr_t * | dc_array_get_raw (const dc_array_t *array) |
Get raw pointer to the data. More... | |
time_t | dc_array_get_timestamp (const dc_array_t *array, size_t index) |
Return the timestamp of the item at the given index. More... | |
uintptr_t | dc_array_get_uint (const dc_array_t *array, size_t index) |
Get the item at the given index as an unsigned integer. More... | |
int | dc_array_is_independent (const dc_array_t *array, size_t index) |
Return the independent-state of the location at the given index. More... | |
void | dc_array_unref (dc_array_t *array) |
Free an array object. More... | |
An object containing a simple array. This object is used in several places where functions need to return an array. The items of the array are typically IDs. To free an array object, use dc_array_unref().
double dc_array_get_accuracy | ( | const dc_array_t * | array, |
size_t | index | ||
) |
Return the accuracy of the item at the given index.
See dc_set_location() for more information about the accuracy.
array | The array object. |
index | Index of the item. Must be between 0 and dc_array_get_cnt()-1. |
uint32_t dc_array_get_chat_id | ( | const dc_array_t * | array, |
size_t | index | ||
) |
Return the chat-id of the item at the given index.
array | The array object. |
index | Index of the item. Must be between 0 and dc_array_get_cnt()-1. |
size_t dc_array_get_cnt | ( | const dc_array_t * | array | ) |
Find out the number of items in an array.
array | The array object. |
uint32_t dc_array_get_contact_id | ( | const dc_array_t * | array, |
size_t | index | ||
) |
Return the contact-id of the item at the given index.
array | The array object. |
index | Index of the item. Must be between 0 and dc_array_get_cnt()-1. |
uint32_t dc_array_get_id | ( | const dc_array_t * | array, |
size_t | index | ||
) |
Get the item at the given index as an ID.
array | The array object. |
index | Index of the item to get. Must be between 0 and dc_array_get_cnt()-1. |
double dc_array_get_latitude | ( | const dc_array_t * | array, |
size_t | index | ||
) |
Return the latitude of the item at the given index.
array | The array object. |
index | Index of the item. Must be between 0 and dc_array_get_cnt()-1. |
double dc_array_get_longitude | ( | const dc_array_t * | array, |
size_t | index | ||
) |
Return the longitude of the item at the given index.
array | The array object. |
index | Index of the item. Must be between 0 and dc_array_get_cnt()-1. |
char * dc_array_get_marker | ( | const dc_array_t * | array, |
size_t | index | ||
) |
Return the marker-character of the item at the given index.
Marker-character are typically bound to locations returned by dc_get_locations() and are typically created by on-character-messages which can also be an emoticon :)
array | The array object. |
index | Index of the item. Must be between 0 and dc_array_get_cnt()-1. |
uint32_t dc_array_get_msg_id | ( | const dc_array_t * | array, |
size_t | index | ||
) |
Return the message-id of the item at the given index.
array | The array object. |
index | Index of the item. Must be between 0 and dc_array_get_cnt()-1. |
void * dc_array_get_ptr | ( | const dc_array_t * | array, |
size_t | index | ||
) |
Get the item at the given index as an ID.
array | The array object. |
index | Index of the item to get. Must be between 0 and dc_array_get_cnt()-1. |
const uintptr_t * dc_array_get_raw | ( | const dc_array_t * | array | ) |
Get raw pointer to the data.
array | The array object. |
time_t dc_array_get_timestamp | ( | const dc_array_t * | array, |
size_t | index | ||
) |
Return the timestamp of the item at the given index.
array | The array object. |
index | Index of the item. Must be between 0 and dc_array_get_cnt()-1. |
uintptr_t dc_array_get_uint | ( | const dc_array_t * | array, |
size_t | index | ||
) |
Get the item at the given index as an unsigned integer.
The size of the integer is always larget enough to hold a pointer.
array | The array object. |
index | Index of the item to get. Must be between 0 and dc_array_get_cnt()-1. |
int dc_array_is_independent | ( | const dc_array_t * | array, |
size_t | index | ||
) |
Return the independent-state of the location at the given index.
Independent locations do not belong to the track of the user.
array | The array object. |
index | Index of the item. Must be between 0 and dc_array_get_cnt()-1. |
void dc_array_unref | ( | dc_array_t * | array | ) |
Free an array object.
Does not free any data items.
array | The array object to free, created eg. by dc_get_chatlist(), dc_get_contacts() and so on. If NULL is given, nothing is done. |