OobsSMBConfig

OobsSMBConfig — Object that represents SMB configuration.

Synopsis




                    OobsSMBConfig;
OobsObject*         oobs_smb_config_get                 (OobsSession *session);
OobsList*           oobs_smb_config_get_shares          (OobsSMBConfig *config);
const gchar*        oobs_smb_config_get_description     (OobsSMBConfig *config);
void                oobs_smb_config_set_description     (OobsSMBConfig *config,
                                                         const gchar *description);
gboolean            oobs_smb_config_get_is_wins_server  (OobsSMBConfig *config);
void                oobs_smb_config_set_is_wins_server  (OobsSMBConfig *config,
                                                         gboolean is_wins_server);
const gchar*        oobs_smb_config_get_wins_server     (OobsSMBConfig *config);
void                oobs_smb_config_set_wins_server     (OobsSMBConfig *config,
                                                         const gchar *wins_server);
const gchar*        oobs_smb_config_get_workgroup       (OobsSMBConfig *config);
void                oobs_smb_config_set_workgroup       (OobsSMBConfig *config,
                                                         const gchar *workgroup);

Object Hierarchy


  GObject
   +----OobsObject
         +----OobsSMBConfig

Properties


  "description"              gchararray            : Read / Write
  "is-wins-server"           gboolean              : Read / Write
  "wins-server"              gchararray            : Read / Write
  "workgroup"                gchararray            : Read / Write

Description

Details

OobsSMBConfig

typedef struct _OobsSMBConfig OobsSMBConfig;

oobs_smb_config_get ()

OobsObject*         oobs_smb_config_get                 (OobsSession *session);

Returns the OobsSMBConfig singleton, which represents the SMB system configuration.

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

oobs_smb_config_get_shares ()

OobsList*           oobs_smb_config_get_shares          (OobsSMBConfig *config);

Returns an OobsList containing objects of type OobsShareSMB.

config : An OobsSMBConfig.
Returns : an OobsList containing the SMB shares information.

oobs_smb_config_get_description ()

const gchar*        oobs_smb_config_get_description     (OobsSMBConfig *config);

Returns the SMB host description.

config : An OobsSMBConfig.
Returns : A pointer to the host description as a string. This string must not be freed, modified or stored.

oobs_smb_config_set_description ()

void                oobs_smb_config_set_description     (OobsSMBConfig *config,
                                                         const gchar *description);

Sets a new SMB host description, overwriting the previous one.

config : An OobsSMBConfig.
description : a new host description.

oobs_smb_config_get_is_wins_server ()

gboolean            oobs_smb_config_get_is_wins_server  (OobsSMBConfig *config);

Returns whether the host is a WINS server for the network.

config : An OobsSMBConfig.
Returns : TRUE if the host is a WINS server.

oobs_smb_config_set_is_wins_server ()

void                oobs_smb_config_set_is_wins_server  (OobsSMBConfig *config,
                                                         gboolean is_wins_server);

Sets whether the host is a WINS server for the network. Note that there must be only one WINS server, so if there's already a WINS server in the network, there wouldn't be the need to set the host as another WINS server.

config : An OobsSMBConfig.
is_wins_server : TRUE if the host is the WINS server for the network.

oobs_smb_config_get_wins_server ()

const gchar*        oobs_smb_config_get_wins_server     (OobsSMBConfig *config);

Returns the WINS server the host is using.

config : An OobsSMBConfig.
Returns : A pointer to the wins server as a string. This string must not be freed, modified or stored.

oobs_smb_config_set_wins_server ()

void                oobs_smb_config_set_wins_server     (OobsSMBConfig *config,
                                                         const gchar *wins_server);

Sets the WINS server that the host will use. This option is mutually exclusive with oobs_smb_config_set_is_wins_server().

config : An OobsSMBConfig.
wins_server : a new WINS server.

oobs_smb_config_get_workgroup ()

const gchar*        oobs_smb_config_get_workgroup       (OobsSMBConfig *config);

Returns the SMB workgroup for the host.

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

oobs_smb_config_set_workgroup ()

void                oobs_smb_config_set_workgroup       (OobsSMBConfig *config,
                                                         const gchar *workgroup);

Sets a new SMB workgroup for the host, overwriting the previous one.

config : An OobsSMBConfig.
workgroup : a new SMB workgroup for the host.

Property Details

The "description" property

  "description"              gchararray            : Read / Write

Description for this host.

Default value: NULL

The "is-wins-server" property

  "is-wins-server"           gboolean              : Read / Write

Whether the host is the WINS server.

Default value: FALSE

The "wins-server" property

  "wins-server"              gchararray            : Read / Write

WINS server that the host will use.

Default value: NULL

The "workgroup" property

  "workgroup"                gchararray            : Read / Write

Workgroup/domain the host is in.

Default value: NULL