:orphan: .. index:: pair: group; Configuration tree access operations .. _doxid-group__confapi__base__access: Configuration tree access operations ==================================== .. toctree:: :hidden: Overview ~~~~~~~~ .. ref-code-block:: cpp :class: doxyrest-overview-code-block // global functions :ref:`te_errno` :ref:`cfg_add_instance`(const :ref:`cfg_oid`* oid, :ref:`cfg_handle`* handle, :ref:`cfg_val_type` type, ...); :ref:`te_errno` :ref:`cfg_add_instance_str`(const char* oid, :ref:`cfg_handle`* p_handle, :ref:`cfg_val_type` type, ...); :ref:`te_errno` :ref:`cfg_add_instance_fmt`(:ref:`cfg_handle`* p_handle, :ref:`cfg_val_type` type, const void* val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`cfg_add_instance_local`(const :ref:`cfg_oid`* oid, :ref:`cfg_handle`* handle, :ref:`cfg_val_type` type, ...); :ref:`te_errno` :ref:`cfg_add_instance_local_str`(const char* oid, :ref:`cfg_handle`* p_handle, :ref:`cfg_val_type` type, ...); :ref:`te_errno` :ref:`cfg_add_instance_local_fmt`(:ref:`cfg_handle`* p_handle, :ref:`cfg_val_type` type, const void* val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`cfg_add_instance_child_fmt`(:ref:`cfg_handle`* p_handle, :ref:`cfg_val_type` type, const void* val, :ref:`cfg_handle` parent, const char* suboid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`cfg_del_instance`(:ref:`cfg_handle` handle, bool with_children); :ref:`te_errno` :ref:`cfg_del_instance_fmt`(bool with_children, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`cfg_del_instance_local`(:ref:`cfg_handle` handle, bool with_children); :ref:`te_errno` :ref:`cfg_del_instance_local_fmt`(bool with_children, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`cfg_set_instance`(:ref:`cfg_handle` handle, :ref:`cfg_val_type` type, ...); :ref:`te_errno` :ref:`cfg_set_instance_fmt`(:ref:`cfg_val_type` type, const void* val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`cfg_set_instance_str`(:ref:`cfg_val_type` type, const void* val, const char* oid); :ref:`te_errno` :ref:`cfg_set_instance_local`(:ref:`cfg_handle` handle, :ref:`cfg_val_type` type, ...); :ref:`te_errno` :ref:`cfg_set_instance_local_fmt`(:ref:`cfg_val_type` type, const void* val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`cfg_commit`(const char* oid); :ref:`te_errno` :ref:`cfg_commit_fmt`(const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`cfg_get_instance`(:ref:`cfg_handle` handle, :ref:`cfg_val_type`* type, ...); :ref:`te_errno` :ref:`cfg_get_instance_fmt`(:ref:`cfg_val_type`* p_type, void* val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`cfg_get_int`(int* val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`cfg_get_bool`(bool* val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`cfg_get_int8`(int8_t* val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`cfg_get_uint8`(uint8_t* val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`cfg_get_int16`(int16_t* val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`cfg_get_uint16`(uint16_t* val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`cfg_get_uint32`(uint32_t* val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`cfg_get_int32`(int32_t* val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`cfg_get_int64`(int64_t* val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`cfg_get_uint64`(uint64_t* val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`cfg_get_double`(double* val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`cfg_get_string`(char** val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`cfg_get_addr`(struct sockaddr** val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`cfg_get_instance_str`(:ref:`cfg_val_type`* p_type, void* val, const char* oid); :ref:`te_errno` :ref:`cfg_get_instance_sync`(:ref:`cfg_handle` handle, :ref:`cfg_val_type`* type, ...); :ref:`te_errno` :ref:`cfg_get_instance_sync_fmt`(:ref:`cfg_val_type`* type, void* val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`cfg_get_int_sync`(int* val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`cfg_get_bool_sync`(bool* val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`cfg_get_int8_sync`(int8_t* val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`cfg_get_uint8_sync`(uint8_t* val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`cfg_get_int16_sync`(int16_t* val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`cfg_get_uint16_sync`(uint16_t* val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`cfg_get_int32_sync`(int32_t* val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`cfg_get_uint32_sync`(uint32_t* val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`cfg_get_int64_sync`(int64_t* val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`cfg_get_uint64_sync`(uint64_t* val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`cfg_get_double_sync`(double* val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`cfg_get_string_sync`(char** val, const char* oid_fmt, ...); :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`cfg_get_addr_sync`(struct sockaddr** val, const char* oid_fmt, ...); .. _details-group__confapi__base__access: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Global Functions ---------------- .. index:: pair: function; cfg_add_instance .. _doxid-group__confapi__base__access_1ga856f5dcea2bf506805e79fc13aa02cde: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` cfg_add_instance(const :ref:`cfg_oid`* oid, :ref:`cfg_handle`* handle, :ref:`cfg_val_type` type, ...) Create an object instance. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - oid - object identifier of the new instance * - handle - location for handle of the new instance * - type - value type (necessary for fast processing) * - ... - value to be assigned to the new instance or NULL; for integer values: int for strings: char \* for addresses: struct sockaddr \* .. rubric:: Returns: Status code (see ``te_errno.h``) .. index:: pair: function; cfg_add_instance_str .. _doxid-group__confapi__base__access_1ga7771fd0dd155ef377ca94d8be282b47c: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` cfg_add_instance_str(const char* oid, :ref:`cfg_handle`* p_handle, :ref:`cfg_val_type` type, ...) Create an object instance. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - oid - object identifier of the new instance (string representation) * - p_handle - location for handle of the new instance (OUT) * - type - value type (necessary for fast processing) * - ... - value to be assigned to the new instance or NULL; for integer values: int for strings: char \* for addresses: struct sockaddr \* .. rubric:: Returns: Status code (see ``te_errno.h``) .. index:: pair: function; cfg_add_instance_fmt .. _doxid-group__confapi__base__access_1ga45cfda8cc1cc54d72c2482c6f48a507e: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` cfg_add_instance_fmt(:ref:`cfg_handle`* p_handle, :ref:`cfg_val_type` type, const void* val, const char* oid_fmt, ...) The same function as cfg_add_instance_str, but OID may be format string. Use macro :ref:`CFG_VAL() ` to make the second and the third arguments pair. E.g. rc = cfg_add_instance_fmt(NULL, :ref:`CFG_VAL(INT32, 1) `, "/hello:tom"); .. index:: pair: function; cfg_add_instance_local .. _doxid-group__confapi__base__access_1ga6962cddecb5fdbd01e628550a256c85c: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` cfg_add_instance_local(const :ref:`cfg_oid`* oid, :ref:`cfg_handle`* handle, :ref:`cfg_val_type` type, ...) Create an object instance locally. Commit should be called to propagate this creation as a bulk to the Test Agent later. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - oid - object identifier of the new instance * - handle - location for handle of the new instance * - type - value type (necessary for fast processing) * - ... - value to be assigned to the new instance or NULL; for integer values: int for strings: char \* for addresses: struct sockaddr \* .. rubric:: Returns: Status code (see ``te_errno.h``) .. index:: pair: function; cfg_add_instance_local_str .. _doxid-group__confapi__base__access_1ga4365e5060e03cba6145615bf6df7c965: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` cfg_add_instance_local_str(const char* oid, :ref:`cfg_handle`* p_handle, :ref:`cfg_val_type` type, ...) The same function as cfg_add_instance_local, but OID is in string format. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - oid - object identifier of the new instance (string representation) * - p_handle - location for handle of the new instance (OUT) * - type - value type (necessary for fast processing) * - ... - value to be assigned to the new instance or NULL; for integer values: int for strings: char \* for addresses: struct sockaddr \* .. rubric:: Returns: Status code (see ``te_errno.h``) .. index:: pair: function; cfg_add_instance_local_fmt .. _doxid-group__confapi__base__access_1gab4943c0e980604b56b98692d6c9ef71e: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` cfg_add_instance_local_fmt(:ref:`cfg_handle`* p_handle, :ref:`cfg_val_type` type, const void* val, const char* oid_fmt, ...) The same function as cfg_add_instance_local_str, but OID may be format string. Use macro :ref:`CFG_VAL() ` to make the second and the third arguments pair. E.g. rc = cfg_add_instance_local_fmt(NULL, :ref:`CFG_VAL(INT32, 1) `, "/hello:tom"); .. index:: pair: function; cfg_add_instance_child_fmt .. _doxid-group__confapi__base__access_1ga1a76e3bd08e81d19703308bc3e7a8d9e: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` cfg_add_instance_child_fmt(:ref:`cfg_handle`* p_handle, :ref:`cfg_val_type` type, const void* val, :ref:`cfg_handle` parent, const char* suboid_fmt, ...) Add instance with the first part of OID specified by handle and the second part specified by format string and its parameters. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - p_handle - Location for handle of new instance * - type - Type of value * - val - Value * - parent - Handle of the parent * - suboid_fmt - Sub-identifier format string * - ... - Format string arguments .. rubric:: Returns: Status code .. index:: pair: function; cfg_del_instance .. _doxid-group__confapi__base__access_1ga5abd708a2c82ecf19e40f91c08916d1e: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` cfg_del_instance(:ref:`cfg_handle` handle, bool with_children) Delete an object instance. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - handle - object instance handle * - with_children - delete the children subtree, if necessary .. rubric:: Returns: Status code (see ``te_errno.h``) .. index:: pair: function; cfg_del_instance_fmt .. _doxid-group__confapi__base__access_1ga30090ed0cdf07ca43115b5496a4fe606: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` cfg_del_instance_fmt(bool with_children, const char* oid_fmt, ...) Set instance by the OID. OID may be format string .. index:: pair: function; cfg_del_instance_local .. _doxid-group__confapi__base__access_1ga941e07b4f0b12eaffd92eeb41754f1fb: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` cfg_del_instance_local(:ref:`cfg_handle` handle, bool with_children) Delete an object instance locally. Commit should be called to propagate this change together with other not committed local changes to TA. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - handle - Object instance handle. * - with_children - Delete the children subtree, if necessary. .. rubric:: Returns: Status code (see ``te_errno.h``). .. index:: pair: function; cfg_del_instance_local_fmt .. _doxid-group__confapi__base__access_1ga0ccf12286a5714839bcce9caba5a8129: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` cfg_del_instance_local_fmt(bool with_children, const char* oid_fmt, ...) Same as :ref:`cfg_del_instance_local() `, but accepts OID string. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - with_children - Delete the children subtree, if necessary. * - oid_fmt - Format string for OID. * - ... - Format string arguments. .. rubric:: Returns: Status code (see ``te_errno.h``). .. index:: pair: function; cfg_set_instance .. _doxid-group__confapi__base__access_1ga8c979af06cc536645552a1f51aad8066: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` cfg_set_instance(:ref:`cfg_handle` handle, :ref:`cfg_val_type` type, ...) Change object instance value. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - handle - object instance handle * - type - value type (necessary for fast processing) * - ... - new value to be assigned to the instance or NULL; for integer values: int for strings: char \* for addresses: struct sockaddr \* .. rubric:: Returns: Status code (see ``te_errno.h``) .. index:: pair: function; cfg_set_instance_fmt .. _doxid-group__confapi__base__access_1ga0ef30d2e2cd16ee8490abb8d45fec2ca: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` cfg_set_instance_fmt(:ref:`cfg_val_type` type, const void* val, const char* oid_fmt, ...) Set instance by the OID. OID may be format string. Use macro :ref:`CFG_VAL() ` to make the first and the second arguments pair. E.g. rc = cfg_set_instance_fmt(:ref:`CFG_VAL(INT32, 1) `, "/hello:"); .. index:: pair: function; cfg_set_instance_str .. _doxid-group__confapi__base__access_1gabc95cb020d020b6f16367fe9fc3314d5: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` cfg_set_instance_str(:ref:`cfg_val_type` type, const void* val, const char* oid) Set instance by the OID string. Use macro :ref:`CFG_VAL() ` to make the first and the second arguments pair. E.g. rc = cfg_set_instance_str(:ref:`CFG_VAL(INT32, 1) `, "/hello:"); .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - type - value type (necessary for fast processing) * - val - value to set * - oid - OID string .. rubric:: Returns: Status code. .. index:: pair: function; cfg_set_instance_local .. _doxid-group__confapi__base__access_1ga45d21edf256b590df80b23e6d6fa88c6: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` cfg_set_instance_local(:ref:`cfg_handle` handle, :ref:`cfg_val_type` type, ...) Change object instance value locally. Commit should be called to propagate changed as a bulk to the Test Agent later. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - handle - object instance handle * - type - value type (necessary for fast processing) * - ... - new value to be assigned to the instance or NULL; for integer values: int for strings: char \* for addresses: struct sockaddr \* .. rubric:: Returns: Status code (see ``te_errno.h``) .. index:: pair: function; cfg_set_instance_local_fmt .. _doxid-group__confapi__base__access_1ga71a414e93926cb59927d20d3d55ec191: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` cfg_set_instance_local_fmt(:ref:`cfg_val_type` type, const void* val, const char* oid_fmt, ...) Set instance by the OID. OID may be format string .. index:: pair: function; cfg_commit .. _doxid-group__confapi__base__access_1gaad97002e07f02c462da2aa3298b93fa1: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` cfg_commit(const char* oid) Commit Configurator database changes to the Test Agent. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - oid - subtree object identifier or NULL if whole database should be synchronized .. rubric:: Returns: Status code (see ``te_errno.h``) .. index:: pair: function; cfg_commit_fmt .. _doxid-group__confapi__base__access_1gabbe8ba443fbb0a5f47f1c1613b7a2d03: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` cfg_commit_fmt(const char* oid_fmt, ...) The same function as cfg_commit, but OID may be format string .. index:: pair: function; cfg_get_instance .. _doxid-group__confapi__base__access_1ga46f53025b3ceb5adbfa99ad3424a5869: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` cfg_get_instance(:ref:`cfg_handle` handle, :ref:`cfg_val_type`* type, ...) Obtain value of the object instance. Memory for strings and addresses is allocated by the routine using malloc(). .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - handle - object instance handle * - type - location for value type, may be NULL * - ... - OUT: location for the value for integer values: int \* for strings: char \*\* for addresses: struct sockaddr \*\* .. rubric:: Returns: Status code (see ``te_errno.h``) .. index:: pair: function; cfg_get_instance_fmt .. _doxid-group__confapi__base__access_1ga8713300c1f12431b4d6dd6d6d8de17d9: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` cfg_get_instance_fmt(:ref:`cfg_val_type`* p_type, void* val, const char* oid_fmt, ...) Get instance by the OID. OID may be format string .. index:: pair: function; cfg_get_int .. _doxid-group__confapi__base__access_1ga5cc89e951a7347ef98b5d6e5ff845473: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` cfg_get_int(int* val, const char* oid_fmt, ...) Type-safe version of :ref:`cfg_get_instance_fmt() ` for values of int type. In reality it looks for int32 values and converts it to int. It is only for backward compatibility. .. index:: pair: function; cfg_get_bool .. _doxid-group__confapi__base__access_1ga60e5cb2374531414ea0c5b37509b9f62: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` cfg_get_bool(bool* val, const char* oid_fmt, ...) Type-safe version of :ref:`cfg_get_instance_fmt() ` for values of bool type .. index:: pair: function; cfg_get_int8 .. _doxid-group__confapi__base__access_1ga612001a6f519816928bf63361f8b22d2: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` cfg_get_int8(int8_t* val, const char* oid_fmt, ...) Type-safe version of :ref:`cfg_get_instance_fmt() ` for values of int8_t type .. index:: pair: function; cfg_get_uint8 .. _doxid-group__confapi__base__access_1ga02bc65518c8bf45dd90d362c26971683: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` cfg_get_uint8(uint8_t* val, const char* oid_fmt, ...) Type-safe version of :ref:`cfg_get_instance_fmt() ` for values of uint8_t type .. index:: pair: function; cfg_get_int16 .. _doxid-group__confapi__base__access_1ga8311ad1a948e821fa0d58f6f406c3337: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` cfg_get_int16(int16_t* val, const char* oid_fmt, ...) Type-safe version of :ref:`cfg_get_instance_fmt() ` for values of int16_t type .. index:: pair: function; cfg_get_uint16 .. _doxid-group__confapi__base__access_1ga7e095e1bed7ff37df48519161f55d9b0: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` cfg_get_uint16(uint16_t* val, const char* oid_fmt, ...) Type-safe version of :ref:`cfg_get_instance_fmt() ` for values of uint16_t type .. index:: pair: function; cfg_get_uint32 .. _doxid-group__confapi__base__access_1ga6063d6940dd6e7d6187972676968b04b: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` cfg_get_uint32(uint32_t* val, const char* oid_fmt, ...) Type-safe version of :ref:`cfg_get_instance_fmt() ` for values of uint32_t type .. index:: pair: function; cfg_get_int32 .. _doxid-group__confapi__base__access_1ga88c36b27b6c36d0127e86f71d3403c1e: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` cfg_get_int32(int32_t* val, const char* oid_fmt, ...) Type-safe version of :ref:`cfg_get_instance_fmt() ` for values of int32_t type .. index:: pair: function; cfg_get_int64 .. _doxid-group__confapi__base__access_1ga5bfee7b51975ed9e4439aca4087a762c: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` cfg_get_int64(int64_t* val, const char* oid_fmt, ...) Type-safe version of :ref:`cfg_get_instance_fmt() ` for values of int64_t type .. index:: pair: function; cfg_get_uint64 .. _doxid-group__confapi__base__access_1gaad56c44051ccd858dea793700241a3eb: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` cfg_get_uint64(uint64_t* val, const char* oid_fmt, ...) Type-safe version of :ref:`cfg_get_instance_fmt() ` for values of uint64_t type .. index:: pair: function; cfg_get_double .. _doxid-group__confapi__base__access_1gaa092323e87fbc7d3475ae96cfd00a808: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` cfg_get_double(double* val, const char* oid_fmt, ...) Type-safe version of :ref:`cfg_get_instance_fmt() ` for values of double type .. index:: pair: function; cfg_get_string .. _doxid-group__confapi__base__access_1ga75b441692afaf18ec414080e676eda5e: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` cfg_get_string(char** val, const char* oid_fmt, ...) Type-safe version of :ref:`cfg_get_instance_fmt() ` for string values .. index:: pair: function; cfg_get_addr .. _doxid-group__confapi__base__access_1gaae062d7a4f2795e3b0cc5c537455586e: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` cfg_get_addr(struct sockaddr** val, const char* oid_fmt, ...) Type-safe version of :ref:`cfg_get_instance_fmt() ` for values of struct sockaddr type .. index:: pair: function; cfg_get_instance_str .. _doxid-group__confapi__base__access_1ga943212d9c917f996579d879efbf79008: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` cfg_get_instance_str(:ref:`cfg_val_type`* p_type, void* val, const char* oid) Get instance by the OID string. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - p_type - location for value type, may be NULL * - val - location for value * - oid - OID string .. rubric:: Returns: Status code. .. index:: pair: function; cfg_get_instance_sync .. _doxid-group__confapi__base__access_1ga408535c456988093cc5e4bd38bb39961: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` cfg_get_instance_sync(:ref:`cfg_handle` handle, :ref:`cfg_val_type`* type, ...) Obtain value of the object instance with synchronization with the managed object. Memory for strings and addresses is allocated by the routine using malloc(). .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - handle - object instance handle * - type - location for the value type * - ... - OUT: location for the value for integer values: int \* for strings: char \*\* for addresses: struct sockaddr \*\* .. rubric:: Returns: Status code (see ``te_errno.h``) .. index:: pair: function; cfg_get_instance_sync_fmt .. _doxid-group__confapi__base__access_1gae72e82b1419c4ac9c27248f6999fe0a1: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` cfg_get_instance_sync_fmt(:ref:`cfg_val_type`* type, void* val, const char* oid_fmt, ...) Get instance by the OID. OID may be format string .. index:: pair: function; cfg_get_int_sync .. _doxid-group__confapi__base__access_1ga8ecfc5cd4a8adbaa994d50f19abef39d: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` cfg_get_int_sync(int* val, const char* oid_fmt, ...) Type-safe version of :ref:`cfg_get_instance_sync_fmt() ` for values of int type. In reality it looks for int32 values and converts it to int. It is only for backward compatibility. .. index:: pair: function; cfg_get_bool_sync .. _doxid-group__confapi__base__access_1ga5d0c67da63055c0187423d00ca4b3851: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` cfg_get_bool_sync(bool* val, const char* oid_fmt, ...) Type-safe version of :ref:`cfg_get_instance_sync_fmt() ` for values of bool type .. index:: pair: function; cfg_get_int8_sync .. _doxid-group__confapi__base__access_1ga852e7f79c738da0ef93c2921f73c8ecc: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` cfg_get_int8_sync(int8_t* val, const char* oid_fmt, ...) Type-safe version of :ref:`cfg_get_instance_sync_fmt() ` for values of int8_t type .. index:: pair: function; cfg_get_uint8_sync .. _doxid-group__confapi__base__access_1ga3e290008cd897579c836c9a29b51ad6a: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` cfg_get_uint8_sync(uint8_t* val, const char* oid_fmt, ...) Type-safe version of :ref:`cfg_get_instance_sync_fmt() ` for values of uint8_t type .. index:: pair: function; cfg_get_int16_sync .. _doxid-group__confapi__base__access_1ga1dcd578356948114309dad43d69285ba: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` cfg_get_int16_sync(int16_t* val, const char* oid_fmt, ...) Type-safe version of :ref:`cfg_get_instance_sync_fmt() ` for values of int16_t type .. index:: pair: function; cfg_get_uint16_sync .. _doxid-group__confapi__base__access_1ga3f3a63a2b7ffa8a065fe4bfd797bdae1: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` cfg_get_uint16_sync(uint16_t* val, const char* oid_fmt, ...) Type-safe version of :ref:`cfg_get_instance_sync_fmt() ` for values of uint16_t type .. index:: pair: function; cfg_get_int32_sync .. _doxid-group__confapi__base__access_1ga3250ef11e4f85f404a09155aafa99247: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` cfg_get_int32_sync(int32_t* val, const char* oid_fmt, ...) Type-safe version of :ref:`cfg_get_instance_sync_fmt() ` for values of int32_t type .. index:: pair: function; cfg_get_uint32_sync .. _doxid-group__confapi__base__access_1ga3bc34d6ee49507ce389b0c73ee88b275: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` cfg_get_uint32_sync(uint32_t* val, const char* oid_fmt, ...) Type-safe version of :ref:`cfg_get_instance_sync_fmt() ` for values of uint32_t type .. index:: pair: function; cfg_get_int64_sync .. _doxid-group__confapi__base__access_1ga4b91849754633207acfa1da6dcd33741: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` cfg_get_int64_sync(int64_t* val, const char* oid_fmt, ...) Type-safe version of :ref:`cfg_get_instance_sync_fmt() ` for values of int64_t type .. index:: pair: function; cfg_get_uint64_sync .. _doxid-group__confapi__base__access_1ga09cbe93e194b3d33cf975a70b41a6365: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` cfg_get_uint64_sync(uint64_t* val, const char* oid_fmt, ...) Type-safe version of :ref:`cfg_get_instance_sync_fmt() ` for values of uint64_t type .. index:: pair: function; cfg_get_double_sync .. _doxid-group__confapi__base__access_1ga6d85a51e6f7c1dc006f8500d642f5234: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` cfg_get_double_sync(double* val, const char* oid_fmt, ...) Type-safe version of :ref:`cfg_get_instance_sync_fmt() ` for values of double type. .. index:: pair: function; cfg_get_string_sync .. _doxid-group__confapi__base__access_1ga5d1c621f7127c38d439558ca66a5a9f6: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` cfg_get_string_sync(char** val, const char* oid_fmt, ...) Type-safe version of :ref:`cfg_get_instance_sync_fmt() ` for string values .. index:: pair: function; cfg_get_addr_sync .. _doxid-group__confapi__base__access_1ga1a26b741f24b727ddc86b42c860d1630: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` :ref:`te_errno` cfg_get_addr_sync(struct sockaddr** val, const char* oid_fmt, ...) Type-safe version of :ref:`cfg_get_instance_sync_fmt() ` for values of struct sockaddr type