matecomponent-property-bag-client

## matecomponent-property-bag-client matecomponent-property-bag-client — simplified property bag client wrapper code |

## Synopsis

    gchar *             matecomponent_pbclient_get_string          (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);
    gchar *             matecomponent_pbclient_get_default_string  (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);
    gchar *             matecomponent_pbclient_get_string_with_default
                                                            (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             gchar *defval,
                                                             gboolean *def);
    gint16              matecomponent_pbclient_get_short           (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);
    gint16              matecomponent_pbclient_get_default_short   (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);
    gint16              matecomponent_pbclient_get_short_with_default
                                                            (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             gint16 defval,
                                                             gboolean *def);
    guint16             matecomponent_pbclient_get_ushort          (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);
    guint16             matecomponent_pbclient_get_default_ushort  (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);
    guint16             matecomponent_pbclient_get_ushort_with_default
                                                            (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             guint16 defval,
                                                             gboolean *def);
    gint32              matecomponent_pbclient_get_long            (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);
    gint32              matecomponent_pbclient_get_default_long    (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);
    gint32              matecomponent_pbclient_get_long_with_default
                                                            (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             gint32 defval,
                                                             gboolean *def);
    guint32             matecomponent_pbclient_get_ulong           (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);
    guint32             matecomponent_pbclient_get_default_ulong   (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);
    guint32             matecomponent_pbclient_get_ulong_with_default
                                                            (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             guint32 defval,
                                                             gboolean *def);
    gfloat              matecomponent_pbclient_get_float           (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);
    gfloat              matecomponent_pbclient_get_default_float   (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);
    gfloat              matecomponent_pbclient_get_float_with_default
                                                            (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             gfloat defval,
                                                             gboolean *def);
    gdouble             matecomponent_pbclient_get_double          (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);
    gdouble             matecomponent_pbclient_get_default_double  (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);
    gdouble             matecomponent_pbclient_get_double_with_default
                                                            (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             gdouble defval,
                                                             gboolean *def);
    gboolean            matecomponent_pbclient_get_boolean         (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);
    gboolean            matecomponent_pbclient_get_default_boolean (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);
    gboolean            matecomponent_pbclient_get_boolean_with_default
                                                            (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             gboolean defval,
                                                             gboolean *def);
    gchar               matecomponent_pbclient_get_char            (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);
    gchar               matecomponent_pbclient_get_default_char    (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);
    gchar               matecomponent_pbclient_get_char_with_default
                                                            (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             gchar defval,
                                                             gboolean *def);
    CORBA_any *         matecomponent_pbclient_get_value           (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_TypeCode opt_tc,
                                                             CORBA_Environment *opt_ev);
    CORBA_any *         matecomponent_pbclient_get_default_value   (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_TypeCode opt_tc,
                                                             CORBA_Environment *opt_ev);
    void                matecomponent_pbclient_set_string          (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             const char *value,
                                                             CORBA_Environment *opt_ev);
    void                matecomponent_pbclient_set_short           (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             gint16 value,
                                                             CORBA_Environment *opt_ev);
    void                matecomponent_pbclient_set_ushort          (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             guint16 value,
                                                             CORBA_Environment *opt_ev);
    void                matecomponent_pbclient_set_long            (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             gint32 value,
                                                             CORBA_Environment *opt_ev);
    void                matecomponent_pbclient_set_ulong           (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             guint32 value,
                                                             CORBA_Environment *opt_ev);
    void                matecomponent_pbclient_set_float           (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             gfloat value,
                                                             CORBA_Environment *opt_ev);
    void                matecomponent_pbclient_set_double          (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             gdouble value,
                                                             CORBA_Environment *opt_ev);
    void                matecomponent_pbclient_set_boolean         (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             gboolean value,
                                                             CORBA_Environment *opt_ev);
    void                matecomponent_pbclient_set_char            (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             gchar value,
                                                             CORBA_Environment *opt_ev);
    void                matecomponent_pbclient_set_value           (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_any *value,
                                                             CORBA_Environment *opt_ev);
    void                matecomponent_pbclient_set_value_async     (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_any *value,
                                                             CORBA_Environment *opt_ev);
    char *              matecomponent_pbclient_get_doc_title       (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);
    char *              matecomponent_pbclient_get_doc             (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);
    GList *             matecomponent_pbclient_get_keys            (MateComponent_PropertyBag bag,
                                                             CORBA_Environment *opt_ev);
    void                matecomponent_pbclient_free_keys           (GList *key_list);
    MateComponent_PropertyFlags  matecomponent_pbclient_get_flags         (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);
    void                matecomponent_pbclient_set                 (MateComponent_PropertyBag bag,
                                                             CORBA_Environment *opt_ev,
                                                             const char *first_prop,
                                                             ...);
    void                matecomponent_pbclient_get                 (MateComponent_PropertyBag bag,
                                                             CORBA_Environment *opt_ev,
                                                             const char *first_prop,
                                                             ...);
    char *              matecomponent_pbclient_setv                (MateComponent_PropertyBag bag,
                                                             CORBA_Environment *ev,
                                                             const char *first_arg,
                                                             va_list var_args);
    char *              matecomponent_pbclient_getv                (MateComponent_PropertyBag bag,
                                                             CORBA_Environment *ev,
                                                             const char *first_arg,
                                                             va_list var_args);
    #define             matecomponent_property_bag_client_setv
    #define             matecomponent_property_bag_client_getv
    #define             matecomponent_property_bag_client_get_property_type
    #define             matecomponent_property_bag_client_get_value_gboolean
    #define             matecomponent_property_bag_client_get_value_gint
    #define             matecomponent_property_bag_client_get_value_glong
    #define             matecomponent_property_bag_client_get_value_gfloat
    #define             matecomponent_property_bag_client_get_value_gdouble
    #define             matecomponent_property_bag_client_get_value_string
    #define             matecomponent_property_bag_client_get_value_any(pb,
                                                             name,
                                                             ev)
    #define             matecomponent_property_bag_client_get_default_gboolean
    #define             matecomponent_property_bag_client_get_default_gint
    #define             matecomponent_property_bag_client_get_default_glong
    #define             matecomponent_property_bag_client_get_default_gfloat
    #define             matecomponent_property_bag_client_get_default_gdouble
    #define             matecomponent_property_bag_client_get_default_string
    #define             matecomponent_property_bag_client_get_default_any(pb,
                                                             name,
                                                             ev)
    #define             matecomponent_property_bag_client_set_value_gboolean
    #define             matecomponent_property_bag_client_set_value_gint
    #define             matecomponent_property_bag_client_set_value_glong
    #define             matecomponent_property_bag_client_set_value_gfloat
    #define             matecomponent_property_bag_client_set_value_gdouble
    #define             matecomponent_property_bag_client_set_value_string
    #define             matecomponent_property_bag_client_set_value_any
    #define             matecomponent_property_bag_client_get_docstring
    #define             matecomponent_property_bag_client_get_flags

## Description

This code is designed to make the property bag interface slightly easier to use, by allowing optional CORBA environments, sensible return values on exceptions, and accessors for specific types of CORBA_Any. eg. matecomponent_property_bag_client_get_value_glong.

With the property bag interface, as in all current remote MateComponent method invocations, translation issues are very dodgy. Assuming that the server process was activated in the correct locale, all should be well, however there is no guarantee that ( in a rapidly changing locale environment ) the string will be correctly translated. It is difficult to know how to solve this problem.

## Details

### matecomponent_pbclient_get_string ()

    gchar *             matecomponent_pbclient_get_string          (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);

Get a string from the PropertyBag

`bag` : | a reference to the PropertyBag
`key` : | key of the value to get
`opt_ev` : | an optional CORBA_Environment to return failure codes
Returns : | the value contained in the database, or zero on error.

### matecomponent_pbclient_get_default_string ()

    gchar *             matecomponent_pbclient_get_default_string  (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);

`bag` : |
`key` : |
`opt_ev` : |
Returns : |

### matecomponent_pbclient_get_string_with_default ()

    gchar *             matecomponent_pbclient_get_string_with_default
                                                            (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             gchar *defval,
                                                             gboolean *def);

`bag` : |
`key` : |
`defval` : |
`def` : |
Returns : |

### matecomponent_pbclient_get_short ()

    gint16              matecomponent_pbclient_get_short           (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);

Get a 16 bit integer from the PropertyBag

`bag` : | a reference to the PropertyBag
`key` : | key of the value to get
`opt_ev` : | an optional CORBA_Environment to return failure codes
Returns : | the value contained in the database.

### matecomponent_pbclient_get_default_short ()

    gint16              matecomponent_pbclient_get_default_short   (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);

`bag` : |
`key` : |
`opt_ev` : |
Returns : |

### matecomponent_pbclient_get_short_with_default ()

    gint16              matecomponent_pbclient_get_short_with_default
                                                            (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             gint16 defval,
                                                             gboolean *def);

`bag` : |
`key` : |
`defval` : |
`def` : |
Returns : |

### matecomponent_pbclient_get_ushort ()

    guint16             matecomponent_pbclient_get_ushort          (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);

Get a 16 bit unsigned integer from the PropertyBag

`bag` : | a reference to the PropertyBag
`key` : | key of the value to get
`opt_ev` : | an optional CORBA_Environment to return failure codes
Returns : | the value contained in the database.

### matecomponent_pbclient_get_default_ushort ()

    guint16             matecomponent_pbclient_get_default_ushort  (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);

`bag` : |
`key` : |
`opt_ev` : |
Returns : |

### matecomponent_pbclient_get_ushort_with_default ()

    guint16             matecomponent_pbclient_get_ushort_with_default
                                                            (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             guint16 defval,
                                                             gboolean *def);

`bag` : |
`key` : |
`defval` : |
`def` : |
Returns : |

### matecomponent_pbclient_get_long ()

    gint32              matecomponent_pbclient_get_long            (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);

Get a 32 bit integer from the PropertyBag

`bag` : | a reference to the PropertyBag
`key` : | key of the value to get
`opt_ev` : | an optional CORBA_Environment to return failure codes
Returns : | the value contained in the database.

### matecomponent_pbclient_get_default_long ()

    gint32              matecomponent_pbclient_get_default_long    (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);

`bag` : |
`key` : |
`opt_ev` : |
Returns : |

### matecomponent_pbclient_get_long_with_default ()

    gint32              matecomponent_pbclient_get_long_with_default
                                                            (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             gint32 defval,
                                                             gboolean *def);

`bag` : |
`key` : |
`defval` : |
`def` : |
Returns : |

### matecomponent_pbclient_get_ulong ()

    guint32             matecomponent_pbclient_get_ulong           (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);

Get a 32 bit unsigned integer from the PropertyBag

`bag` : | a reference to the PropertyBag
`key` : | key of the value to get
`opt_ev` : | an optional CORBA_Environment to return failure codes
Returns : | the value contained in the database.

### matecomponent_pbclient_get_default_ulong ()

    guint32             matecomponent_pbclient_get_default_ulong   (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);

`bag` : |
`key` : |
`opt_ev` : |
Returns : |

### matecomponent_pbclient_get_ulong_with_default ()

    guint32             matecomponent_pbclient_get_ulong_with_default
                                                            (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             guint32 defval,
                                                             gboolean *def);

`bag` : |
`key` : |
`defval` : |
`def` : |
Returns : |

### matecomponent_pbclient_get_float ()

    gfloat              matecomponent_pbclient_get_float           (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);

Get a single precision floating point value from the PropertyBag

`bag` : | a reference to the PropertyBag
`key` : | key of the value to get
`opt_ev` : | an optional CORBA_Environment to return failure codes
Returns : | the value contained in the database.

### matecomponent_pbclient_get_default_float ()

    gfloat              matecomponent_pbclient_get_default_float   (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);

`bag` : |
`key` : |
`opt_ev` : |
Returns : |

### matecomponent_pbclient_get_float_with_default ()

    gfloat              matecomponent_pbclient_get_float_with_default
                                                            (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             gfloat defval,
                                                             gboolean *def);

`bag` : |
`key` : |
`defval` : |
`def` : |
Returns : |

### matecomponent_pbclient_get_double ()

    gdouble             matecomponent_pbclient_get_double          (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);

Get a double precision floating point value from the PropertyBag

`bag` : | a reference to the PropertyBag
`key` : | key of the value to get
`opt_ev` : | an optional CORBA_Environment to return failure codes
Returns : | the value contained in the database.

### matecomponent_pbclient_get_default_double ()

    gdouble             matecomponent_pbclient_get_default_double  (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);

`bag` : |
`key` : |
`opt_ev` : |
Returns : |

### matecomponent_pbclient_get_double_with_default ()

    gdouble             matecomponent_pbclient_get_double_with_default
                                                            (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             gdouble defval,
                                                             gboolean *def);

`bag` : |
`key` : |
`defval` : |
`def` : |
Returns : |

### matecomponent_pbclient_get_boolean ()

    gboolean            matecomponent_pbclient_get_boolean         (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);

Get a boolean value from the PropertyBag

`bag` : | a reference to the PropertyBag
`key` : | key of the value to get
`opt_ev` : | an optional CORBA_Environment to return failure codes
Returns : | the value contained in the database.

### matecomponent_pbclient_get_default_boolean ()

    gboolean            matecomponent_pbclient_get_default_boolean (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);

`bag` : |
`key` : |
`opt_ev` : |
Returns : |

### matecomponent_pbclient_get_boolean_with_default ()

    gboolean            matecomponent_pbclient_get_boolean_with_default
                                                            (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             gboolean defval,
                                                             gboolean *def);

`bag` : |
`key` : |
`defval` : |
`def` : |
Returns : |

### matecomponent_pbclient_get_char ()

    gchar               matecomponent_pbclient_get_char            (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);

Get a 8 bit character value from the PropertyBag

`bag` : | a reference to the PropertyBag
`key` : | key of the value to get
`opt_ev` : | an optional CORBA_Environment to return failure codes
Returns : | the value contained in the database.

### matecomponent_pbclient_get_default_char ()

    gchar               matecomponent_pbclient_get_default_char    (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);

`bag` : |
`key` : |
`opt_ev` : |
Returns : |

### matecomponent_pbclient_get_char_with_default ()

    gchar               matecomponent_pbclient_get_char_with_default
                                                            (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             gchar defval,
                                                             gboolean *def);

`bag` : |
`key` : |
`defval` : |
`def` : |
Returns : |

### matecomponent_pbclient_get_value ()

    CORBA_any *         matecomponent_pbclient_get_value           (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_TypeCode opt_tc,
                                                             CORBA_Environment *opt_ev);

Get a value from the PropertyBag

`bag` : | a reference to the PropertyBag object
`key` : | key of the value to get
`opt_tc` : | the type of the value, optional
`opt_ev` : | an optional CORBA_Environment to return failure codes
Returns : | the value contained in the PropertyBag, or zero on error.

### matecomponent_pbclient_get_default_value ()

    CORBA_any *         matecomponent_pbclient_get_default_value   (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_TypeCode opt_tc,
                                                             CORBA_Environment *opt_ev);

Get the default value from the PropertyBag

`bag` : | a reference to the PropertyBag object
`key` : | key of the value to get
`opt_tc` : | the type of the value, optional
`opt_ev` : | an optional CORBA_Environment to return failure codes
Returns : | the default value contained in the PropertyBag, or zero on error.

### matecomponent_pbclient_set_string ()

    void                matecomponent_pbclient_set_string          (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             const char *value,
                                                             CORBA_Environment *opt_ev);

Set a string value in the PropertyBag.

`bag` : | a reference to the PropertyBag
`key` : | key of the value to set
`value` : | the new value
`opt_ev` : | an optional CORBA_Environment to return failure codes

### matecomponent_pbclient_set_short ()

    void                matecomponent_pbclient_set_short           (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             gint16 value,
                                                             CORBA_Environment *opt_ev);

Set a 16 bit integer value in the PropertyBag.

`bag` : | a reference to the PropertyBag
`key` : | key of the value to set
`value` : | the new value
`opt_ev` : | an optional CORBA_Environment to return failure codes

### matecomponent_pbclient_set_ushort ()

    void                matecomponent_pbclient_set_ushort          (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             guint16 value,
                                                             CORBA_Environment *opt_ev);

Set a 16 bit unsigned integer value in the PropertyBag.

`bag` : | a reference to the PropertyBag
`key` : | key of the value to set
`value` : | the new value
`opt_ev` : | an optional CORBA_Environment to return failure codes

### matecomponent_pbclient_set_long ()

    void                matecomponent_pbclient_set_long            (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             gint32 value,
                                                             CORBA_Environment *opt_ev);

Set a 32 bit integer value in the PropertyBag.

`bag` : | a reference to the PropertyBag
`key` : | key of the value to set
`value` : | the new value
`opt_ev` : | an optional CORBA_Environment to return failure codes

### matecomponent_pbclient_set_ulong ()

    void                matecomponent_pbclient_set_ulong           (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             guint32 value,
                                                             CORBA_Environment *opt_ev);

Set a 32 bit unsigned integer value in the PropertyBag.

`bag` : | a reference to the PropertyBag
`key` : | key of the value to set
`value` : | the new value
`opt_ev` : | an optional CORBA_Environment to return failure codes

### matecomponent_pbclient_set_float ()

    void                matecomponent_pbclient_set_float           (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             gfloat value,
                                                             CORBA_Environment *opt_ev);

Set a single precision floating point value in the PropertyBag.

`bag` : | a reference to the PropertyBag
`key` : | key of the value to set
`value` : | the new value
`opt_ev` : | an optional CORBA_Environment to return failure codes

### matecomponent_pbclient_set_double ()

    void                matecomponent_pbclient_set_double          (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             gdouble value,
                                                             CORBA_Environment *opt_ev);

Set a double precision floating point value in the PropertyBag.

`bag` : | a reference to the PropertyBag
`key` : | key of the value to set
`value` : | the new value
`opt_ev` : | an optional CORBA_Environment to return failure codes

### matecomponent_pbclient_set_boolean ()

    void                matecomponent_pbclient_set_boolean         (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             gboolean value,
                                                             CORBA_Environment *opt_ev);

Set a boolean value in the PropertyBag.

`bag` : | a reference to the PropertyBag
`key` : | key of the value to set
`value` : | the new value
`opt_ev` : | an optional CORBA_Environment to return failure codes

### matecomponent_pbclient_set_char ()

    void                matecomponent_pbclient_set_char            (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             gchar value,
                                                             CORBA_Environment *opt_ev);

Set a 8 bit characte value in the PropertyBag.

`bag` : | a reference to the PropertyBag
`key` : | key of the value to set
`value` : | the new value
`opt_ev` : | an optional CORBA_Environment to return failure codes

### matecomponent_pbclient_set_value ()

    void                matecomponent_pbclient_set_value           (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_any *value,
                                                             CORBA_Environment *opt_ev);

Set a value in the PropertyBag.

`bag` : | a reference to the PropertyBag
`key` : | key of the value to set
`value` : | the new value
`opt_ev` : | an optional CORBA_Environment to return failure codes

### matecomponent_pbclient_set_value_async ()

    void                matecomponent_pbclient_set_value_async     (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_any *value,
                                                             CORBA_Environment *opt_ev);

Set a value on the PropertyBag asynchronously, discarding any possible roundtrip exceptions.

`bag` : | a reference to the PropertyBag
`key` : | key of the value to set
`value` : | the new value
`opt_ev` : | an optional CORBA_Environment to return failure codes

### matecomponent_pbclient_get_doc_title ()

    char *              matecomponent_pbclient_get_doc_title       (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);

`bag` : |
`key` : |
`opt_ev` : |
Returns : |

### matecomponent_pbclient_get_doc ()

    char *              matecomponent_pbclient_get_doc             (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);

`bag` : |
`key` : |
`opt_ev` : |
Returns : |

### matecomponent_pbclient_get_keys ()

    GList *             matecomponent_pbclient_get_keys            (MateComponent_PropertyBag bag,
                                                             CORBA_Environment *opt_ev);

`bag` : |
`opt_ev` : |
Returns : |

### matecomponent_pbclient_free_keys ()

    void                matecomponent_pbclient_free_keys           (GList *key_list);

`key_list` : |

### matecomponent_pbclient_get_flags ()

    MateComponent_PropertyFlags  matecomponent_pbclient_get_flags         (MateComponent_PropertyBag bag,
                                                             const char *key,
                                                             CORBA_Environment *opt_ev);

`bag` : |
`key` : |
`opt_ev` : |
Returns : |

### matecomponent_pbclient_set ()

    void                matecomponent_pbclient_set                 (MateComponent_PropertyBag bag,
                                                             CORBA_Environment *opt_ev,
                                                             const char *first_prop,
                                                             ...);

`bag` : |
`opt_ev` : |
`first_prop` : |
`...` : |

### matecomponent_pbclient_get ()

    void                matecomponent_pbclient_get                 (MateComponent_PropertyBag bag,
                                                             CORBA_Environment *opt_ev,
                                                             const char *first_prop,
                                                             ...);

`bag` : |
`opt_ev` : |
`first_prop` : |
`...` : |

### matecomponent_pbclient_setv ()

    char *              matecomponent_pbclient_setv                (MateComponent_PropertyBag bag,
                                                             CORBA_Environment *ev,
                                                             const char *first_arg,
                                                             va_list var_args);

This function provides the grunt implementation for other var-arg functions like matecomponent_widget_set_property

`bag` : | the property bag
`ev` : | optional CORBA exception environment or NULL
`first_arg` : | first argument name
`var_args` : | list of subsequent name / type / value triplets
Returns : | an error string on error or NULL on success.

### matecomponent_pbclient_getv ()

    char *              matecomponent_pbclient_getv                (MateComponent_PropertyBag bag,
                                                             CORBA_Environment *ev,
                                                             const char *first_arg,
                                                             va_list var_args);

This function provides the grunt implementation for other var-arg functions like matecomponent_widget_get_property.

`bag` : | the property bag
`ev` : | optional CORBA exception environment or NULL
`first_arg` : | first argument name
`var_args` : | list of subsequent name / type / value triplets
Returns : | an error string on error or NULL on success.

### matecomponent_property_bag_client_setv

    #define             matecomponent_property_bag_client_setv

Returns : |

### matecomponent_property_bag_client_getv

    #define             matecomponent_property_bag_client_getv

Returns : |

### matecomponent_property_bag_client_get_property_type

    #define             matecomponent_property_bag_client_get_property_type

Returns : |

### matecomponent_property_bag_client_get_value_gboolean

    #define             matecomponent_property_bag_client_get_value_gboolean

Returns : |

### matecomponent_property_bag_client_get_value_gint

    #define             matecomponent_property_bag_client_get_value_gint

Returns : |

### matecomponent_property_bag_client_get_value_glong

    #define             matecomponent_property_bag_client_get_value_glong

Returns : |

### matecomponent_property_bag_client_get_value_gfloat

    #define             matecomponent_property_bag_client_get_value_gfloat

Returns : |

### matecomponent_property_bag_client_get_value_gdouble

    #define             matecomponent_property_bag_client_get_value_gdouble

Returns : |

### matecomponent_property_bag_client_get_value_string

    #define             matecomponent_property_bag_client_get_value_string

Returns : |

### matecomponent_property_bag_client_get_value_any()

    #define             matecomponent_property_bag_client_get_value_any(pb, name, ev)

`pb` : |
`name` : |
`ev` : |
Returns : |

### matecomponent_property_bag_client_get_default_gboolean

    #define             matecomponent_property_bag_client_get_default_gboolean

Returns : |

### matecomponent_property_bag_client_get_default_gint

    #define             matecomponent_property_bag_client_get_default_gint

Returns : |

### matecomponent_property_bag_client_get_default_glong

    #define             matecomponent_property_bag_client_get_default_glong

Returns : |

### matecomponent_property_bag_client_get_default_gfloat

    #define             matecomponent_property_bag_client_get_default_gfloat

Returns : |

### matecomponent_property_bag_client_get_default_gdouble

    #define             matecomponent_property_bag_client_get_default_gdouble

Returns : |

### matecomponent_property_bag_client_get_default_string

    #define             matecomponent_property_bag_client_get_default_string

Returns : |

### matecomponent_property_bag_client_get_default_any()

    #define             matecomponent_property_bag_client_get_default_any(pb, name, ev)

`pb` : |
`name` : |
`ev` : |
Returns : |

### matecomponent_property_bag_client_set_value_gboolean

    #define             matecomponent_property_bag_client_set_value_gboolean

### matecomponent_property_bag_client_set_value_gint

    #define             matecomponent_property_bag_client_set_value_gint

### matecomponent_property_bag_client_set_value_glong

    #define             matecomponent_property_bag_client_set_value_glong

### matecomponent_property_bag_client_set_value_gfloat

    #define             matecomponent_property_bag_client_set_value_gfloat

### matecomponent_property_bag_client_set_value_gdouble

    #define             matecomponent_property_bag_client_set_value_gdouble

### matecomponent_property_bag_client_set_value_string

    #define             matecomponent_property_bag_client_set_value_string

### matecomponent_property_bag_client_set_value_any

    #define             matecomponent_property_bag_client_set_value_any

### matecomponent_property_bag_client_get_docstring

    #define             matecomponent_property_bag_client_get_docstring

Returns : |

### matecomponent_property_bag_client_get_flags

    #define             matecomponent_property_bag_client_get_flags

Returns : |

## See Also

MateComponentPropertyBag, MateComponentProperty, MateComponentPropertyControl