|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
<html>
|
|
Packit |
5756e2 |
<head>
|
|
Packit |
5756e2 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
Packit |
5756e2 |
<title>NMSettingUser: libnm Reference Manual</title>
|
|
Packit |
5756e2 |
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
|
|
Packit |
5756e2 |
<link rel="home" href="index.html" title="libnm Reference Manual">
|
|
Packit |
5756e2 |
<link rel="up" href="ch03.html" title="Connection and Setting API Reference">
|
|
Packit |
5756e2 |
<link rel="prev" href="NMSettingTun.html" title="NMSettingTun">
|
|
Packit Service |
a1bd4f |
<link rel="next" href="NMSettingVeth.html" title="NMSettingVeth">
|
|
Packit Service |
87a54e |
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
|
|
Packit |
5756e2 |
<link rel="stylesheet" href="style.css" type="text/css">
|
|
Packit |
5756e2 |
</head>
|
|
Packit |
5756e2 |
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Top |
|
|
Packit |
5756e2 |
Description
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit Service |
a1bd4f |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NMSettingUser
|
|
Packit |
5756e2 |
NMSettingUser — Describes user properties
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Functions
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NMSetting *
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_setting_user_new ()
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit Service |
a1bd4f |
const char *const *
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_setting_user_get_keys ()
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
const char *
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_setting_user_get_data ()
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
gboolean
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_setting_user_set_data ()
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
gboolean
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_setting_user_check_key ()
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
gboolean
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_setting_user_check_val ()
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Types and Values
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
#define
|
|
Packit |
5756e2 |
NM_SETTING_USER_SETTING_NAME
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
#define
|
|
Packit |
5756e2 |
NM_SETTING_USER_DATA
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Description
|
|
Packit |
5756e2 |
The NMSettingUser object is a NMSetting subclass that allow to attach
|
|
Packit |
5756e2 |
arbitrary user data to NMConnection objects.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Functions
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_setting_user_new ()
|
|
Packit |
5756e2 |
NMSetting *
|
|
Packit |
5756e2 |
nm_setting_user_new (void);
|
|
Packit |
5756e2 |
Creates a new NMSettingUser object with default values.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Returns
|
|
Packit |
5756e2 |
the new empty NMSettingUser object
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_setting_user_get_keys ()
|
|
Packit Service |
a1bd4f |
const char *const *
|
|
Packit |
5756e2 |
nm_setting_user_get_keys (NMSettingUser *setting,
|
|
Packit |
5756e2 |
guint *out_len);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Parameters
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
setting
|
|
Packit |
5756e2 |
the NMSettingUser
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
out_len
|
|
Packit |
5756e2 |
the length of the returned array.
|
|
Packit |
5756e2 |
[out]
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Returns
|
|
Packit |
5756e2 |
a
|
|
Packit |
5756e2 |
NULL-terminated array containing each key from the table.
|
|
Packit Service |
87a54e |
[array length=out_len][transfer none]
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_setting_user_get_data ()
|
|
Packit |
5756e2 |
const char *
|
|
Packit |
5756e2 |
nm_setting_user_get_data (NMSettingUser *setting,
|
|
Packit |
5756e2 |
const char *key);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Parameters
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
setting
|
|
Packit |
5756e2 |
the NMSettingUser instance
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
key
|
|
Packit |
5756e2 |
the key to lookup
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Returns
|
|
Packit |
5756e2 |
the value associated with key
|
|
Packit |
5756e2 |
or NULL if no such
|
|
Packit |
5756e2 |
value exists.
|
|
Packit Service |
87a54e |
[transfer none]
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Since: 1.8
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_setting_user_set_data ()
|
|
Packit |
5756e2 |
gboolean
|
|
Packit |
5756e2 |
nm_setting_user_set_data (NMSettingUser *setting,
|
|
Packit |
5756e2 |
const char *key,
|
|
Packit |
5756e2 |
const char *val,
|
|
Packit |
5756e2 |
GError **error);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Parameters
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
setting
|
|
Packit |
5756e2 |
the NMSettingUser instance
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
key
|
|
Packit |
5756e2 |
the key to set
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
val
|
|
Packit |
5756e2 |
the value to set or NULL to clear a key.
|
|
Packit |
5756e2 |
[allow-none]
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
error
|
|
Packit |
5756e2 |
optional error argument.
|
|
Packit |
5756e2 |
[allow-none]
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Returns
|
|
Packit |
5756e2 |
TRUE if the operation was successful. The operation
|
|
Packit |
5756e2 |
can fail if key
|
|
Packit |
5756e2 |
or val
|
|
Packit |
5756e2 |
are not valid strings according
|
|
Packit |
5756e2 |
to nm_setting_user_check_key() and nm_setting_user_check_val().
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Since: 1.8
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_setting_user_check_key ()
|
|
Packit |
5756e2 |
gboolean
|
|
Packit |
5756e2 |
nm_setting_user_check_key (const char *key,
|
|
Packit |
5756e2 |
GError **error);
|
|
Packit |
5756e2 |
Checks whether key
|
|
Packit |
5756e2 |
is a valid user data key. This means,
|
|
Packit |
5756e2 |
key is not NULL, not too large and valid ASCII. Also,
|
|
Packit |
5756e2 |
only digits and numbers are allowed with a few special
|
|
Packit |
5756e2 |
characters. The key must contain at least one '.' and
|
|
Packit |
5756e2 |
look like a fully qualified DNS name.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Parameters
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
key
|
|
Packit |
5756e2 |
the key to check
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
error
|
|
Packit |
5756e2 |
a GError, NULL to ignore.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Returns
|
|
Packit |
5756e2 |
TRUE if key
|
|
Packit |
5756e2 |
is a valid user data key.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Since: 1.8
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_setting_user_check_val ()
|
|
Packit |
5756e2 |
gboolean
|
|
Packit |
5756e2 |
nm_setting_user_check_val (const char *val,
|
|
Packit |
5756e2 |
GError **error);
|
|
Packit |
5756e2 |
Checks whether val
|
|
Packit |
5756e2 |
is a valid user data value. This means,
|
|
Packit |
5756e2 |
value is not NULL, not too large and valid UTF-8.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Parameters
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
val
|
|
Packit |
5756e2 |
the value to check
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
error
|
|
Packit |
5756e2 |
a GError, NULL to ignore.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Returns
|
|
Packit |
5756e2 |
TRUE if val
|
|
Packit |
5756e2 |
is a valid user data value.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Since: 1.8
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Types and Values
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NM_SETTING_USER_SETTING_NAME
|
|
Packit Service |
a1bd4f |
#define NM_SETTING_USER_SETTING_NAME "user"
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NM_SETTING_USER_DATA
|
|
Packit Service |
a1bd4f |
#define NM_SETTING_USER_DATA "data"
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit Service |
87a54e |
Generated by GTK-Doc V1.33.1
|
|
Packit |
5756e2 |
</body>
|
|
Packit |
5756e2 |
</html>
|