OobsShareSMB

OobsShareSMB — Object that represents an individual SMB share.

Synopsis




enum                OobsShareSMBFlags;
#define             OOBS_TYPE_SHARE_SMB_FLAGS
                    OobsShareSMB;
const gchar*        oobs_share_smb_get_name             (OobsShareSMB *share);
void                oobs_share_smb_set_name             (OobsShareSMB *share,
                                                         const gchar *name);
const gchar*        oobs_share_smb_get_comment          (OobsShareSMB *share);
void                oobs_share_smb_set_comment          (OobsShareSMB *share,
                                                         const gchar *comment);
OobsShareSMBFlags   oobs_share_smb_get_flags            (OobsShareSMB *share);
void                oobs_share_smb_set_flags            (OobsShareSMB *share,
                                                         OobsShareSMBFlags flags);
OobsShare*          oobs_share_smb_new                  (const gchar *path,
                                                         const gchar *name,
                                                         const gchar *comment,
                                                         OobsShareSMBFlags flags);

Object Hierarchy


  GObject
   +----OobsShare
         +----OobsShareSMB

Properties


  "comment"                  gchararray            : Read / Write / Construct
  "flags"                    OobsShareSMBFlags     : Read / Write / Construct
  "name"                     gchararray            : Read / Write / Construct

Description

Details

enum OobsShareSMBFlags

typedef enum {
  OOBS_SHARE_SMB_ENABLED   = 1 << 0,
  OOBS_SHARE_SMB_BROWSABLE = 1 << 1,
  OOBS_SHARE_SMB_PUBLIC    = 1 << 2,
  OOBS_SHARE_SMB_WRITABLE  = 1 << 3,
} OobsShareSMBFlags;

OOBS_TYPE_SHARE_SMB_FLAGS

#define OOBS_TYPE_SHARE_SMB_FLAGS   (oobs_share_smb_flags_get_type())

OobsShareSMB

typedef struct _OobsShareSMB OobsShareSMB;

oobs_share_smb_get_name ()

const gchar*        oobs_share_smb_get_name             (OobsShareSMB *share);

Returns the share name.

share : An OobsShareSMB.
Returns : A pointer to the share name as a string. This string must not be freed, modified or stored.

oobs_share_smb_set_name ()

void                oobs_share_smb_set_name             (OobsShareSMB *share,
                                                         const gchar *name);

Sets a new name for the share, overwriting the previous one.

share : An OobsShareSMB.
name : new name for the share.

oobs_share_smb_get_comment ()

const gchar*        oobs_share_smb_get_comment          (OobsShareSMB *share);

Returns the comment for the share.

share : An OobsShareSMB.
Returns : A pointer to the share comment as a string. This string must not be freed, modified or stored.

oobs_share_smb_set_comment ()

void                oobs_share_smb_set_comment          (OobsShareSMB *share,
                                                         const gchar *comment);

Sets a new comment for the share, overwriting the previous one.

share : An OobsShareSMB.
comment : new comment for the share.

oobs_share_smb_get_flags ()

OobsShareSMBFlags   oobs_share_smb_get_flags            (OobsShareSMB *share);

Returns the options mask of the share.

share : An OobsShareSMB.
Returns : OobsShareSMBFlags mask representing the share options.

oobs_share_smb_set_flags ()

void                oobs_share_smb_set_flags            (OobsShareSMB *share,
                                                         OobsShareSMBFlags flags);

Sets a new set of options for the share.

share : An OobsShareSMB.
flags : mask of options for the share.

oobs_share_smb_new ()

OobsShare*          oobs_share_smb_new                  (const gchar *path,
                                                         const gchar *name,
                                                         const gchar *comment,
                                                         OobsShareSMBFlags flags);

Creates a new OobsShareSMB with the given settings.

path : folder path for the new share.
name : name for the new share.
comment : comment for the new share.
flags : options mask for the new share.
Returns : a newly allocated OobsShareSMB.

Property Details

The "comment" property

  "comment"                  gchararray            : Read / Write / Construct

Comment for the share.

Default value: NULL

The "flags" property

  "flags"                    OobsShareSMBFlags     : Read / Write / Construct

Property flags for the share.

The "name" property

  "name"                     gchararray            : Read / Write / Construct

Default value: NULL