From f408e27bccfacf347605a8d98649975a68f38a17 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 5 May 2015 17:48:57 +0200 Subject: Imported Upstream version 1.0.2 --- docs/libnm-util/html/NMSettingCdma.html | 584 ++++++++++++++++++-------------- 1 file changed, 327 insertions(+), 257 deletions(-) (limited to 'docs/libnm-util/html/NMSettingCdma.html') diff --git a/docs/libnm-util/html/NMSettingCdma.html b/docs/libnm-util/html/NMSettingCdma.html index 3a201d2d..e0d32198 100644 --- a/docs/libnm-util/html/NMSettingCdma.html +++ b/docs/libnm-util/html/NMSettingCdma.html @@ -2,34 +2,28 @@ -NMSettingCdma +libnm-util Reference Manual: NMSettingCdma - + - - - - - - - - - - + + + + + + +
@@ -37,61 +31,290 @@

NMSettingCdma

NMSettingCdma — Describes CDMA-based mobile broadband properties

- +
-
-

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);
-
+
+

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 *numberRead / Write
+gchar *passwordRead / Write
guintpassword-flagsRead / Write
+gchar *usernameRead / Write
+
+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineNM_SETTING_CDMA_SETTING_NAME
enumNMSettingCdmaError
#defineNM_SETTING_CDMA_ERROR
#defineNM_SETTING_CDMA_NUMBER
#defineNM_SETTING_CDMA_USERNAME
#defineNM_SETTING_CDMA_PASSWORD
#defineNM_SETTING_CDMA_PASSWORD_FLAGS

Object Hierarchy

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

Properties

-
-  "number"                   gchar*                : Read / Write
-  "password"                 gchar*                : Read / Write
-  "password-flags"           guint                 : Read / Write
-  "username"                 gchar*                : Read / Write
+
Includes

+
#include <nm-setting-cdma.h>

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. -

+networks, including those using CDMA2000/EVDO technology.

-

Details

+

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”

+

+
+
+
+
+

Types and Values

NM_SETTING_CDMA_SETTING_NAME

#define NM_SETTING_CDMA_SETTING_NAME "cdma"
@@ -101,45 +324,50 @@ networks, including those using CDMA2000/EVDO technology.
-

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;
-
-
+

enum NMSettingCdmaError

+
+

Members

+
--+++ - - + + - - + + - - + + - - + +

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

@@ -150,24 +378,6 @@ 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"
@@ -198,185 +408,45 @@ Registers an error quark for -

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*                : 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. -

+

The “number” property

+
  “number”                   gchar *
+

+

Flags: Read / Write

Default value: NULL

-

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. -

+

The “password” property

+
  “password”                 gchar *
+

+

Flags: Read / Write

Default value: NULL

-

The "password-flags" property

-
  "password-flags"           guint                 : Read / Write
-

-Flags indicating how to handle the "password" property. -

+

The “password-flags” property

+
  “password-flags”           guint
+

+

Flags: Read / Write

Allowed values: <= 7

Default value: 0

-

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. -

+

The “username” property

+
  “username”                 gchar *
+

+

Flags: Read / Write

Default value: NULL

- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.21 \ No newline at end of file -- cgit 1.3.0-6-gf8a5