libnm-util Reference Manual: NMSettingCdma

@@ -31,290 +37,61 @@

NMSettingCdma

NMSettingCdma — Describes CDMA-based mobile broadband properties

- +

Functions

---- - - - - - - - - - - - - - - - - - - - - - - - - - - -

-GQuark -	-nm_setting_cdma_error_quark () -
-NMSetting * -	-nm_setting_cdma_new () -
const char * -	-nm_setting_cdma_get_number () -
const char * -	-nm_setting_cdma_get_username () -
const char * -	-nm_setting_cdma_get_password () -
-NMSettingSecretFlags -	-nm_setting_cdma_get_password_flags () -

Properties

----- - - - - - - - - - - - - - - - - - - - - - - -

-gchar *	number	Read / Write
-gchar *	password	Read / Write
guint	password-flags	Read / Write
-gchar *	username	Read / Write

Types and Values

---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

#define	NM_SETTING_CDMA_SETTING_NAME
enum	NMSettingCdmaError
#define	NM_SETTING_CDMA_ERROR
#define	NM_SETTING_CDMA_NUMBER
#define	NM_SETTING_CDMA_USERNAME
#define	NM_SETTING_CDMA_PASSWORD
#define	NM_SETTING_CDMA_PASSWORD_FLAGS

Synopsis

+#include <nm-setting-cdma.h>
+
+#define             NM_SETTING_CDMA_SETTING_NAME
+enum                NMSettingCdmaError;
+#define             NM_SETTING_CDMA_ERROR
+GQuark              nm_setting_cdma_error_quark         (void);
+#define             NM_SETTING_CDMA_NUMBER
+#define             NM_SETTING_CDMA_USERNAME
+#define             NM_SETTING_CDMA_PASSWORD
+#define             NM_SETTING_CDMA_PASSWORD_FLAGS
+                    NMSettingCdma;
+                    NMSettingCdmaClass;
+NMSetting *         nm_setting_cdma_new                 (void);
+const char *        nm_setting_cdma_get_number          (NMSettingCdma *setting);
+const char *        nm_setting_cdma_get_username        (NMSettingCdma *setting);
+const char *        nm_setting_cdma_get_password        (NMSettingCdma *setting);
+NMSettingSecretFlags nm_setting_cdma_get_password_flags (NMSettingCdma *setting);
+

Object Hierarchy

    GEnum
-    ╰── NMSettingCdmaError
-    GObject
-    ╰── NMSetting
-        ╰── NMSettingCdma
++  GEnum
+   +----NMSettingCdmaError
+
++  GObject
+   +----NMSetting
+         +----NMSettingCdma

Includes

#include <nm-setting-cdma.h>
+Properties
++  "number"                   gchar*                : Read / Write
+  "password"                 gchar*                : Read / Write
+  "password-flags"           guint                 : Read / Write
+  "username"                 gchar*                : Read / Write

Description

The NMSettingCdma object is a NMSetting subclass that describes +

+The NMSettingCdma object is a NMSetting subclass that describes properties that allow connections to IS-95-based mobile broadband -networks, including those using CDMA2000/EVDO technology.

Functions

nm_setting_cdma_error_quark ()

GQuark
-nm_setting_cdma_error_quark (void);

Registers an error quark for NMSettingCdma if necessary.

Returns

the error quark used for NMSettingCdma errors.

nm_setting_cdma_new ()

NMSetting *
-nm_setting_cdma_new (void);

Creates a new NMSettingCdma object with default values.

Returns

the new empty NMSettingCdma object

nm_setting_cdma_get_number ()

const char *
-nm_setting_cdma_get_number (NMSettingCdma *setting);

Parameters

----- - - - - - -

setting

the NMSettingCdma

Returns

the “number” property of the setting

nm_setting_cdma_get_username ()

const char *
-nm_setting_cdma_get_username (NMSettingCdma *setting);

Parameters

----- - - - - - -

setting

the NMSettingCdma

Returns

the “username” property of the setting

nm_setting_cdma_get_password ()

const char *
-nm_setting_cdma_get_password (NMSettingCdma *setting);

Parameters

----- - - - - - -

setting

the NMSettingCdma

Returns

the “password” property of the setting

nm_setting_cdma_get_password_flags ()

NMSettingSecretFlags
-nm_setting_cdma_get_password_flags (NMSettingCdma *setting);

Parameters

----- - - - - - -

setting

the NMSettingCdma

Returns

the NMSettingSecretFlags pertaining to the “password”

+networks, including those using CDMA2000/EVDO technology. +

Types and Values

Details

NM_SETTING_CDMA_SETTING_NAME

#define NM_SETTING_CDMA_SETTING_NAME "cdma"
@@ -324,50 +101,45 @@ nm_setting_cdma_get_password_flags (
 
 
-enum NMSettingCdmaError
-
-Members
-
+enum NMSettingCdmaError
+typedef enum {
+	NM_SETTING_CDMA_ERROR_UNKNOWN = 0,           /*< nick=UnknownError >*/
+	NM_SETTING_CDMA_ERROR_INVALID_PROPERTY,      /*< nick=InvalidProperty >*/
+	NM_SETTING_CDMA_ERROR_MISSING_PROPERTY,      /*< nick=MissingProperty >*/
+	NM_SETTING_CDMA_ERROR_MISSING_SERIAL_SETTING /*< nick=MissingSerialSetting >*/
+} NMSettingCdmaError;
+
+
---++
-
-
+
-
-
-
+
-
-
-
+
-
-
-
+
-
 





 
 
 NM_SETTING_CDMA_ERROR_UNKNOWN 
-unknown or unclassified error
+ NM_SETTING_CDMA_ERROR_UNKNOWN unknown or unclassified error
  
 
 NM_SETTING_CDMA_ERROR_INVALID_PROPERTY 
-the property was invalid
+ NM_SETTING_CDMA_ERROR_INVALID_PROPERTY the property was invalid
  
 
 NM_SETTING_CDMA_ERROR_MISSING_PROPERTY 
-the property was missing and is
-required
+ NM_SETTING_CDMA_ERROR_MISSING_PROPERTY the property was missing and is
+required
  
 
 NM_SETTING_CDMA_ERROR_MISSING_SERIAL_SETTING 
-the required NMSettingSerial
-is missing in the connection
+ NM_SETTING_CDMA_ERROR_MISSING_SERIAL_SETTING the required NMSettingSerial
+is missing in the connection
  
 
 
 
 
-
 
 
 NM_SETTING_CDMA_ERROR
@@ -378,6 +150,24 @@ is missing in the connection
 
 
 
+nm_setting_cdma_error_quark ()
+GQuark              nm_setting_cdma_error_quark         (void);
+
+Registers an error quark for NMSettingCdma if necessary.
+
+
++++
+
+
+
+
+


Returns : the error quark used for NMSettingCdma errors.
+
+
+
 NM_SETTING_CDMA_NUMBER
 #define NM_SETTING_CDMA_NUMBER         "number"
 
@@ -408,45 +198,185 @@ is missing in the connection
 
 
 
+
+
+NMSettingCdma
+typedef struct _NMSettingCdma NMSettingCdma;
+
+
+
+
+
+NMSettingCdmaClass
+typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingCdmaClass;
+
+
+
+
+
+
+nm_setting_cdma_new ()
+NMSetting *         nm_setting_cdma_new                 (void);
+
+Creates a new NMSettingCdma object with default values.
+
+
++++
+
+
+
+
+


Returns : the new empty NMSettingCdma object
+
+
+
+nm_setting_cdma_get_number ()
+const char *        nm_setting_cdma_get_number          (NMSettingCdma *setting);
+
++++
+
+
+
+
+
+
+
+
+
+
+


setting : the NMSettingCdma
+
Returns : the "number" property of the setting
+
+
+
+nm_setting_cdma_get_username ()
+const char *        nm_setting_cdma_get_username        (NMSettingCdma *setting);
+
++++
+
+
+
+
+
+
+
+
+
+
+


setting : the NMSettingCdma
+
Returns : the "username" property of the setting
+
+
+
+nm_setting_cdma_get_password ()
+const char *        nm_setting_cdma_get_password        (NMSettingCdma *setting);
+
++++
+
+
+
+
+
+
+
+
+
+
+


setting : the NMSettingCdma
+
Returns : the "password" property of the setting
+
+
+
+nm_setting_cdma_get_password_flags ()
+NMSettingSecretFlags nm_setting_cdma_get_password_flags (NMSettingCdma *setting);
+
++++
+
+
+
+
+
+
+
+
+
+
+


setting : the NMSettingCdma
+
Returns : the NMSettingSecretFlags pertaining to the "password"
+
+

Property Details -The “number” property - “number” gchar * -Number to dial when establishing a PPP data session with the CDMA-based mobile broadband network. If not specified, the default number (#777) is used when required. -Flags: Read / Write +The "number" property + "number" gchar* : Read / Write + +The number to dial to establish the connection to the CDMA-based mobile +broadband network, if any. If not specified, the default number (777) +is used when required. + Default value: NULL -The “password” property - “password” gchar * -Password used to authenticate with the network, if required. Note that many providers do not require a password or accept any password. -Flags: Read / Write +The "password" property + "password" gchar* : Read / Write + +The password used to authenticate with the network, if required. Many +providers do not require a password, or accept any password. But if a +password is required, it is specified here. + Default value: NULL -The “password-flags” property - “password-flags” guint -Flags indicating how to handle the CDMA password. -Flags: Read / Write +The "password-flags" property + "password-flags" guint : Read / Write + +Flags indicating how to handle the "password" property. + Allowed values: <= 7 Default value: 0 -The “username” property - “username” gchar * -Username used to authenticate with the network, if required. Note that many providers do not require a username or accept any username. -Flags: Read / Write +The "username" property + "username" gchar* : Read / Write + +The username used to authenticate with the network, if required. Many +providers do not require a username, or accept any username. But if a +username is required, it is specified here. + Default value: NULL

- Generated by GTK-Doc V1.20 + Generated by GTK-Doc V1.19

\ No newline at end of file -- cgit 1.3.0-6-gf8a5

			libnm-util Reference Manual
+Top + \| + Description + \| + Object Hierarchy + \| + Properties +

NM_SETTING_CDMA_ERROR_UNKNOWN	- unknown or unclassified error +	`NM_SETTING_CDMA_ERROR_UNKNOWN`	unknown or unclassified error
NM_SETTING_CDMA_ERROR_INVALID_PROPERTY	- the property was invalid +	`NM_SETTING_CDMA_ERROR_INVALID_PROPERTY`	the property was invalid
NM_SETTING_CDMA_ERROR_MISSING_PROPERTY	- the property was missing and is -required +	`NM_SETTING_CDMA_ERROR_MISSING_PROPERTY`	the property was missing and is +required
NM_SETTING_CDMA_ERROR_MISSING_SERIAL_SETTING	- the required NMSettingSerial -is missing in the connection +	`NM_SETTING_CDMA_ERROR_MISSING_SERIAL_SETTING`	the required NMSettingSerial +is missing in the connection

`setting` :	the NMSettingCdma +
Returns :	the "number" property of the setting