OobsUsersConfig

OobsUsersConfig — Object that represents users configuration.

Synopsis




                    OobsUsersConfig;
OobsObject*         oobs_users_config_get               (OobsSession *session);
OobsList*           oobs_users_config_get_users         (OobsUsersConfig *config);
uid_t               oobs_users_config_get_minimum_users_uid
                                                        (OobsUsersConfig *config);
void                oobs_users_config_set_minimum_users_uid
                                                        (OobsUsersConfig *config,
                                                         uid_t uid);
uid_t               oobs_users_config_get_maximum_users_uid
                                                        (OobsUsersConfig *config);
void                oobs_users_config_set_maximum_users_uid
                                                        (OobsUsersConfig *config,
                                                         uid_t uid);
const gchar*        oobs_users_config_get_default_shell (OobsUsersConfig *config);
void                oobs_users_config_set_default_shell (OobsUsersConfig *config,
                                                         const gchar *shell);
const gchar*        oobs_users_config_get_default_home_dir
                                                        (OobsUsersConfig *config);
void                oobs_users_config_set_default_home_dir
                                                        (OobsUsersConfig *config,
                                                         const gchar *home_dir);
OobsGroup*          oobs_users_config_get_default_group (OobsUsersConfig *config);
GList*              oobs_users_config_get_available_shells
                                                        (OobsUsersConfig *config);

Object Hierarchy


  GObject
   +----OobsObject
         +----OobsUsersConfig

Properties


  "default-group"            OobsGroup             : Read
  "default-home"             gchararray            : Read / Write
  "default-shell"            gchararray            : Read / Write
  "maximum-uid"              gint                  : Read / Write
  "minimum-uid"              gint                  : Read / Write
  "use-md5"                  gboolean              : Read

Description

Details

OobsUsersConfig

typedef struct _OobsUsersConfig OobsUsersConfig;

oobs_users_config_get ()

OobsObject*         oobs_users_config_get               (OobsSession *session);

Returns the OobsUsersConfig singleton, which represents the system users and their configuration.

session : An OobsSession.
Returns : the singleton OobsUsersConfig object.

oobs_users_config_get_users ()

OobsList*           oobs_users_config_get_users         (OobsUsersConfig *config);

Returns an OobsList containing objects of type OobsUser.

config : An OobsUsersConfig.
Returns : an OobsList containing the system users.

oobs_users_config_get_minimum_users_uid ()

uid_t               oobs_users_config_get_minimum_users_uid
                                                        (OobsUsersConfig *config);

Returns the default minimum UID for non-system users.

config : An OobsUsersConfig.
Returns : minimum UID for non-system users.

oobs_users_config_set_minimum_users_uid ()

void                oobs_users_config_set_minimum_users_uid
                                                        (OobsUsersConfig *config,
                                                         uid_t uid);

Sets the minimum UID for non-system users.

config : An OobsUsersConfig.
uid : new minimum UID for non-system users.

oobs_users_config_get_maximum_users_uid ()

uid_t               oobs_users_config_get_maximum_users_uid
                                                        (OobsUsersConfig *config);

Returns the default maximum UID for non-system users.

config : An OobsUsersConfig.
Returns : maximum UID for non-system users.

oobs_users_config_set_maximum_users_uid ()

void                oobs_users_config_set_maximum_users_uid
                                                        (OobsUsersConfig *config,
                                                         uid_t uid);

Sets the maximum UID for non-system users.

config : An OobsUsersConfig.
uid : a new maximum UID for non-system users.

oobs_users_config_get_default_shell ()

const gchar*        oobs_users_config_get_default_shell (OobsUsersConfig *config);

Returns the default shell that will be used for new users.

config : An OobsUsersConfig
Returns : A pointer to the default shell as a string. This string must not be freed, modified or stored.

oobs_users_config_set_default_shell ()

void                oobs_users_config_set_default_shell (OobsUsersConfig *config,
                                                         const gchar *shell);

Sets a new default shell for new users, replacing the old one.

config : An OobsUsersConfig
shell : new default shell for new users.

oobs_users_config_get_default_home_dir ()

const gchar*        oobs_users_config_get_default_home_dir
                                                        (OobsUsersConfig *config);

Returns the default home directory prefix for new users. when new users are created a directory with the user login name is created in that prefix.

config : An OobsUsersConfig.
Returns : A pointer to the default home directory prefix as a string. This string must not be freed, modified or stored.

oobs_users_config_set_default_home_dir ()

void                oobs_users_config_set_default_home_dir
                                                        (OobsUsersConfig *config,
                                                         const gchar *home_dir);

Sets a new home directory prefix used for newly created users, replacing the old one.

config : An OobsIfacesConfig.
home_dir : new default home directory prefix.

oobs_users_config_get_default_group ()

OobsGroup*          oobs_users_config_get_default_group (OobsUsersConfig *config);

Returns an OobsGroup defining the default group used for new users.

config : An OobsUsersConfig.
Returns : An OobsGroup, you must not unref this object.

oobs_users_config_get_available_shells ()

GList*              oobs_users_config_get_available_shells
                                                        (OobsUsersConfig *config);

Returns a GList containing strings with paths to the available shells.

config : An OobsUsersConfig
Returns : a GList containing strings, you must not free neither this list or its elements.

Property Details

The "default-group" property

  "default-group"            OobsGroup             : Read

Default group for new users.

The "default-home" property

  "default-home"             gchararray            : Read / Write

Default home directory for new users.

Default value: NULL

The "default-shell" property

  "default-shell"            gchararray            : Read / Write

Default shell for new users.

Default value: NULL

The "maximum-uid" property

  "maximum-uid"              gint                  : Read / Write

Maximum UID for non-system users.

Allowed values: [0,65534]

Default value: 65534

The "minimum-uid" property

  "minimum-uid"              gint                  : Read / Write

Minimum UID for non-system users.

Allowed values: [0,65534]

Default value: 65534

The "use-md5" property

  "use-md5"                  gboolean              : Read

Whether users' passwords are stored in MD5.

Default value: FALSE