UIM enumerations and flags

UIM enumerations and flags

Synopsis

enum                QmiUimSessionType;
enum                QmiUimFileType;
enum                QmiUimSecurityAttributeLogic;
enum                QmiUimSecurityAttribute;
enum                QmiUimCardState;
enum                QmiUimCardError;
enum                QmiUimPinState;
enum                QmiUimCardApplicationType;
enum                QmiUimCardApplicationState;
enum                QmiUimCardApplicationPersonalizationState;
enum                QmiUimCardApplicationPersonalizationFeature;
enum                QmiUimPinId;

const gchar *       qmi_uim_session_type_get_string     (QmiUimSessionType val);
const gchar *       qmi_uim_file_type_get_string        (QmiUimFileType val);
const gchar *       qmi_uim_security_attribute_logic_get_string
                                                        (QmiUimSecurityAttributeLogic val);
gchar *             qmi_uim_security_attribute_build_string_from_mask
                                                        (QmiUimSecurityAttribute mask);
const gchar *       qmi_uim_card_state_get_string       (QmiUimCardState val);
const gchar *       qmi_uim_card_error_get_string       (QmiUimCardError val);
const gchar *       qmi_uim_pin_state_get_string        (QmiUimPinState val);
const gchar *       qmi_uim_card_application_type_get_string
                                                        (QmiUimCardApplicationType val);
const gchar *       qmi_uim_card_application_state_get_string
                                                        (QmiUimCardApplicationState val);
const gchar *       qmi_uim_card_application_personalization_state_get_string
                                                        (QmiUimCardApplicationPersonalizationState val);
const gchar *       qmi_uim_card_application_personalization_feature_get_string
                                                        (QmiUimCardApplicationPersonalizationFeature val);
const gchar *       qmi_uim_pin_id_get_string           (QmiUimPinId val);

Object Hierarchy

  GEnum
   +----QmiUimSessionType
  GEnum
   +----QmiUimFileType
  GEnum
   +----QmiUimSecurityAttributeLogic
  GFlags
   +----QmiUimSecurityAttribute
  GEnum
   +----QmiUimCardState
  GEnum
   +----QmiUimCardError
  GEnum
   +----QmiUimPinState
  GEnum
   +----QmiUimCardApplicationType
  GEnum
   +----QmiUimCardApplicationState
  GEnum
   +----QmiUimCardApplicationPersonalizationState
  GEnum
   +----QmiUimCardApplicationPersonalizationFeature
  GEnum
   +----QmiUimPinId

Description

This section defines enumerations and flags used in the UIM service interface.

Details

enum QmiUimSessionType

typedef enum {
    QMI_UIM_SESSION_TYPE_PRIMARY_GW_PROVISIONING   = 0,
    QMI_UIM_SESSION_TYPE_PRIMARY_1X_PROVISIONING   = 1,
    QMI_UIM_SESSION_TYPE_SECONDARY_GW_PROVISIONING = 2,
    QMI_UIM_SESSION_TYPE_SECONDARY_1X_PROVISIONING = 3,
    QMI_UIM_SESSION_TYPE_NONPROVISIONING_SLOT_1    = 4,
    QMI_UIM_SESSION_TYPE_NONPROVISIONING_SLOT_2    = 5,
    QMI_UIM_SESSION_TYPE_CARD_SLOT_1               = 6,
    QMI_UIM_SESSION_TYPE_CARD_SLOT_2               = 7,
    QMI_UIM_SESSION_TYPE_LOGICAL_CHANNEL_SLOT_1    = 8,
    QMI_UIM_SESSION_TYPE_LOGICAL_CHANNEL_SLOT_2    = 9
} QmiUimSessionType;

Type of UIM session.

QMI_UIM_SESSION_TYPE_PRIMARY_GW_PROVISIONING

Primary GSM/WCDMA provisioning.

QMI_UIM_SESSION_TYPE_PRIMARY_1X_PROVISIONING

Primary CDMA1x provisioning.

QMI_UIM_SESSION_TYPE_SECONDARY_GW_PROVISIONING

Secondary GSM/WCDMA provisioning.

QMI_UIM_SESSION_TYPE_SECONDARY_1X_PROVISIONING

Secondary CDMA1x provisioning.

QMI_UIM_SESSION_TYPE_NONPROVISIONING_SLOT_1

Nonprovisioning on slot 1.

QMI_UIM_SESSION_TYPE_NONPROVISIONING_SLOT_2

Nonprovisioning on slot 2.

QMI_UIM_SESSION_TYPE_CARD_SLOT_1

Card on slot 1.

QMI_UIM_SESSION_TYPE_CARD_SLOT_2

Card on slot 2.

QMI_UIM_SESSION_TYPE_LOGICAL_CHANNEL_SLOT_1

Logical channel on slot 1.

QMI_UIM_SESSION_TYPE_LOGICAL_CHANNEL_SLOT_2

Logical channel on slot 2.

enum QmiUimFileType

typedef enum {
    QMI_UIM_FILE_TYPE_TRANSPARENT    = 0,
    QMI_UIM_FILE_TYPE_CYCLIC         = 1,
    QMI_UIM_FILE_TYPE_LINEAR_FIXED   = 2,
    QMI_UIM_FILE_TYPE_DEDICATED_FILE = 3,
    QMI_UIM_FILE_TYPE_MASTER_FILE    = 4
} QmiUimFileType;

Type of UIM file.

QMI_UIM_FILE_TYPE_TRANSPARENT

Transparent.

QMI_UIM_FILE_TYPE_CYCLIC

Cyclic.

QMI_UIM_FILE_TYPE_LINEAR_FIXED

Linear fixed.

QMI_UIM_FILE_TYPE_DEDICATED_FILE

Dedicated file.

QMI_UIM_FILE_TYPE_MASTER_FILE

Master file.

enum QmiUimSecurityAttributeLogic

typedef enum {
    QMI_UIM_SECURITY_ATTRIBUTE_LOGIC_ALWAYS = 0,
    QMI_UIM_SECURITY_ATTRIBUTE_LOGIC_NEVER  = 1,
    QMI_UIM_SECURITY_ATTRIBUTE_LOGIC_AND    = 2,
    QMI_UIM_SECURITY_ATTRIBUTE_LOGIC_OR     = 3,
    QMI_UIM_SECURITY_ATTRIBUTE_LOGIC_SINGLE = 4
} QmiUimSecurityAttributeLogic;

Logic applicable to security attributes.

QMI_UIM_SECURITY_ATTRIBUTE_LOGIC_ALWAYS

Always.

QMI_UIM_SECURITY_ATTRIBUTE_LOGIC_NEVER

Never.

QMI_UIM_SECURITY_ATTRIBUTE_LOGIC_AND

And.

QMI_UIM_SECURITY_ATTRIBUTE_LOGIC_OR

Or.

QMI_UIM_SECURITY_ATTRIBUTE_LOGIC_SINGLE

Single.

enum QmiUimSecurityAttribute

typedef enum {
    QMI_UIM_SECURITY_ATTRIBUTE_PIN1 = 1 << 0,
    QMI_UIM_SECURITY_ATTRIBUTE_PIN2 = 1 << 1,
    QMI_UIM_SECURITY_ATTRIBUTE_UPIN = 1 << 2,
    QMI_UIM_SECURITY_ATTRIBUTE_ADM  = 1 << 3
} QmiUimSecurityAttribute;

Security Attributes.

QMI_UIM_SECURITY_ATTRIBUTE_PIN1

PIN1.

QMI_UIM_SECURITY_ATTRIBUTE_PIN2

PIN2.

QMI_UIM_SECURITY_ATTRIBUTE_UPIN

UPIN.

QMI_UIM_SECURITY_ATTRIBUTE_ADM

ADM.

enum QmiUimCardState

typedef enum {
    QMI_UIM_CARD_STATE_ABSENT  = 0,
    QMI_UIM_CARD_STATE_PRESENT = 1,
    QMI_UIM_CARD_STATE_ERROR   = 2
} QmiUimCardState;

State of the card.

QMI_UIM_CARD_STATE_ABSENT

Absent.

QMI_UIM_CARD_STATE_PRESENT

Present.

QMI_UIM_CARD_STATE_ERROR

Error.

enum QmiUimCardError

typedef enum {
    QMI_UIM_CARD_ERROR_UNKNOWN          = 0,
    QMI_UIM_CARD_ERROR_POWER_DOWN       = 1,
    QMI_UIM_CARD_ERROR_POLL             = 2,
    QMI_UIM_CARD_ERROR_NO_ATR_RECEIVED  = 3,
    QMI_UIM_CARD_ERROR_VOLTAGE_MISMATCH = 4,
    QMI_UIM_CARD_ERROR_PARITY           = 5,
    QMI_UIM_CARD_ERROR_POSSIBLY_REMOVED = 6,
    QMI_UIM_CARD_ERROR_TECHNICAL        = 7
} QmiUimCardError;

Card error.

QMI_UIM_CARD_ERROR_UNKNOWN

Unknown error.

QMI_UIM_CARD_ERROR_POWER_DOWN

Power down.

QMI_UIM_CARD_ERROR_POLL

Poll error.

QMI_UIM_CARD_ERROR_NO_ATR_RECEIVED

No ATR received.

QMI_UIM_CARD_ERROR_VOLTAGE_MISMATCH

Voltage mismatch.

QMI_UIM_CARD_ERROR_PARITY

Parity error.

QMI_UIM_CARD_ERROR_POSSIBLY_REMOVED

Unknown error, possibly removed.

QMI_UIM_CARD_ERROR_TECHNICAL

Technical problem.

enum QmiUimPinState

typedef enum {
    QMI_UIM_PIN_STATE_NOT_INITIALIZED      = 0,
    QMI_UIM_PIN_STATE_ENABLED_NOT_VERIFIED = 1,
    QMI_UIM_PIN_STATE_ENABLED_VERIFIED     = 2,
    QMI_UIM_PIN_STATE_DISABLED             = 3,
    QMI_UIM_PIN_STATE_BLOCKED              = 4,
    QMI_UIM_PIN_STATE_PERMANENTLY_BLOCKED  = 5,
} QmiUimPinState;

The PIN state.

QMI_UIM_PIN_STATE_NOT_INITIALIZED

Not initialized.

QMI_UIM_PIN_STATE_ENABLED_NOT_VERIFIED

Enabled, not verified.

QMI_UIM_PIN_STATE_ENABLED_VERIFIED

Enabled, verified.

QMI_UIM_PIN_STATE_DISABLED

Disabled.

QMI_UIM_PIN_STATE_BLOCKED

Blocked.

QMI_UIM_PIN_STATE_PERMANENTLY_BLOCKED

Permanently Blocked.

enum QmiUimCardApplicationType

typedef enum {
    QMI_UIM_CARD_APPLICATION_TYPE_UNKNOWN = 0,
    QMI_UIM_CARD_APPLICATION_TYPE_SIM     = 1,
    QMI_UIM_CARD_APPLICATION_TYPE_USIM    = 2,
    QMI_UIM_CARD_APPLICATION_TYPE_RUIM    = 3,
    QMI_UIM_CARD_APPLICATION_TYPE_CSIM    = 4,
    QMI_UIM_CARD_APPLICATION_TYPE_ISIM    = 5,
} QmiUimCardApplicationType;

Card application type.

QMI_UIM_CARD_APPLICATION_TYPE_UNKNOWN

Unknown.

QMI_UIM_CARD_APPLICATION_TYPE_SIM

SIM.

QMI_UIM_CARD_APPLICATION_TYPE_USIM

USIM.

QMI_UIM_CARD_APPLICATION_TYPE_RUIM

RUIM.

QMI_UIM_CARD_APPLICATION_TYPE_CSIM

CSIM.

QMI_UIM_CARD_APPLICATION_TYPE_ISIM

ISIM.

enum QmiUimCardApplicationState

typedef enum {
    QMI_UIM_CARD_APPLICATION_STATE_UNKNOWN                     = 0,
    QMI_UIM_CARD_APPLICATION_STATE_DETECTED                    = 1,
    QMI_UIM_CARD_APPLICATION_STATE_PIN1_OR_UPIN_PIN_REQUIRED   = 2,
    QMI_UIM_CARD_APPLICATION_STATE_PUK1_OR_UPIN_PUK_REQUIRED   = 3,
    QMI_UIM_CARD_APPLICATION_STATE_CHECK_PERSONALIZATION_STATE = 4,
    QMI_UIM_CARD_APPLICATION_STATE_PIN1_BLOCKED                = 5,
    QMI_UIM_CARD_APPLICATION_STATE_ILLEGAL                     = 6,
    QMI_UIM_CARD_APPLICATION_STATE_READY                       = 7,
} QmiUimCardApplicationState;

Card application state.

QMI_UIM_CARD_APPLICATION_STATE_UNKNOWN

Unknown.

QMI_UIM_CARD_APPLICATION_STATE_DETECTED

Detected.

QMI_UIM_CARD_APPLICATION_STATE_PIN1_OR_UPIN_PIN_REQUIRED

PIN1 or UPIN PIN required.

QMI_UIM_CARD_APPLICATION_STATE_PUK1_OR_UPIN_PUK_REQUIRED

PUK1 or UPIN PUK required.

QMI_UIM_CARD_APPLICATION_STATE_CHECK_PERSONALIZATION_STATE

Personalization state must be checked.

QMI_UIM_CARD_APPLICATION_STATE_PIN1_BLOCKED

PIN1 blocked.

QMI_UIM_CARD_APPLICATION_STATE_ILLEGAL

Illegal.

QMI_UIM_CARD_APPLICATION_STATE_READY

Ready

enum QmiUimCardApplicationPersonalizationState

typedef enum {
    QMI_UIM_CARD_APPLICATION_PERSONALIZATION_STATE_UNKNOWN             = 0,
    QMI_UIM_CARD_APPLICATION_PERSONALIZATION_STATE_IN_PROGRESS         = 1,
    QMI_UIM_CARD_APPLICATION_PERSONALIZATION_STATE_READY               = 2,
    QMI_UIM_CARD_APPLICATION_PERSONALIZATION_STATE_CODE_REQUIRED       = 3,
    QMI_UIM_CARD_APPLICATION_PERSONALIZATION_STATE_PUK_CODE_REQUIRED   = 4,
    QMI_UIM_CARD_APPLICATION_PERSONALIZATION_STATE_PERMANENTLY_BLOCKED = 5,
} QmiUimCardApplicationPersonalizationState;

Card application personalization state.

QMI_UIM_CARD_APPLICATION_PERSONALIZATION_STATE_UNKNOWN

Unknown.

QMI_UIM_CARD_APPLICATION_PERSONALIZATION_STATE_IN_PROGRESS

Operation in progress.

QMI_UIM_CARD_APPLICATION_PERSONALIZATION_STATE_READY

Ready.

QMI_UIM_CARD_APPLICATION_PERSONALIZATION_STATE_CODE_REQUIRED

Code required.

QMI_UIM_CARD_APPLICATION_PERSONALIZATION_STATE_PUK_CODE_REQUIRED

PUK code required.

QMI_UIM_CARD_APPLICATION_PERSONALIZATION_STATE_PERMANENTLY_BLOCKED

Permanently blocked-

enum QmiUimCardApplicationPersonalizationFeature

typedef enum {
    QMI_UIM_CARD_APPLICATION_PERSONALIZATION_FEATURE_GW_NETWORK          = 0,
    QMI_UIM_CARD_APPLICATION_PERSONALIZATION_FEATURE_GW_NETWORK_SUBSET   = 1,
    QMI_UIM_CARD_APPLICATION_PERSONALIZATION_FEATURE_GW_SERVICE_PROVIDER = 2,
    QMI_UIM_CARD_APPLICATION_PERSONALIZATION_FEATURE_GW_CORPORATE        = 3,
    QMI_UIM_CARD_APPLICATION_PERSONALIZATION_FEATURE_GW_UIM              = 4,
    QMI_UIM_CARD_APPLICATION_PERSONALIZATION_FEATURE_1X_NETWORK_TYPE_1   = 5,
    QMI_UIM_CARD_APPLICATION_PERSONALIZATION_FEATURE_1X_NETWORK_TYPE_2   = 6,
    QMI_UIM_CARD_APPLICATION_PERSONALIZATION_FEATURE_1X_HRPD             = 7,
    QMI_UIM_CARD_APPLICATION_PERSONALIZATION_FEATURE_1X_SERVICE_PROVIDER = 8,
    QMI_UIM_CARD_APPLICATION_PERSONALIZATION_FEATURE_1X_CORPORATE        = 9,
    QMI_UIM_CARD_APPLICATION_PERSONALIZATION_FEATURE_1X_RUIM             = 10,
    QMI_UIM_CARD_APPLICATION_PERSONALIZATION_FEATURE_UNKNOWN             = 11
} QmiUimCardApplicationPersonalizationFeature;

Card application personalization feature, when a code is required.

QMI_UIM_CARD_APPLICATION_PERSONALIZATION_FEATURE_GW_NETWORK

GW network.

QMI_UIM_CARD_APPLICATION_PERSONALIZATION_FEATURE_GW_NETWORK_SUBSET

GW network subset.

QMI_UIM_CARD_APPLICATION_PERSONALIZATION_FEATURE_GW_SERVICE_PROVIDER

GW service provider.

QMI_UIM_CARD_APPLICATION_PERSONALIZATION_FEATURE_GW_CORPORATE

GW corporate.

QMI_UIM_CARD_APPLICATION_PERSONALIZATION_FEATURE_GW_UIM

UIM.

QMI_UIM_CARD_APPLICATION_PERSONALIZATION_FEATURE_1X_NETWORK_TYPE_1

1X network type 1.

QMI_UIM_CARD_APPLICATION_PERSONALIZATION_FEATURE_1X_NETWORK_TYPE_2

1X network type 2.

QMI_UIM_CARD_APPLICATION_PERSONALIZATION_FEATURE_1X_HRPD

1X HRPD.

QMI_UIM_CARD_APPLICATION_PERSONALIZATION_FEATURE_1X_SERVICE_PROVIDER

1X service provider.

QMI_UIM_CARD_APPLICATION_PERSONALIZATION_FEATURE_1X_CORPORATE

1X corporate.

QMI_UIM_CARD_APPLICATION_PERSONALIZATION_FEATURE_1X_RUIM

1X R-UIM.

QMI_UIM_CARD_APPLICATION_PERSONALIZATION_FEATURE_UNKNOWN

Unknown.

enum QmiUimPinId

typedef enum {
    QMI_UIM_PIN_ID_UNKNOWN    = 0,
    QMI_UIM_PIN_ID_PIN1       = 1,
    QMI_UIM_PIN_ID_PIN2       = 2,
    QMI_UIM_PIN_ID_UPIN       = 3,
    QMI_UIM_PIN_ID_HIDDEN_KEY = 4
} QmiUimPinId;

PIN ID.

QMI_UIM_PIN_ID_UNKNOWN

Unknown.

QMI_UIM_PIN_ID_PIN1

PIN1.

QMI_UIM_PIN_ID_PIN2

PIN2.

QMI_UIM_PIN_ID_UPIN

UPIN.

QMI_UIM_PIN_ID_HIDDEN_KEY

Hidden key.

qmi_uim_session_type_get_string ()

const gchar *       qmi_uim_session_type_get_string     (QmiUimSessionType val);

Gets the nickname string for the QmiUimSessionType specified at val.

val :

a QmiUimSessionType.

Returns :

a string with the nickname, or NULL if not found. Do not free the returned value. [transfer none]

qmi_uim_file_type_get_string ()

const gchar *       qmi_uim_file_type_get_string        (QmiUimFileType val);

Gets the nickname string for the QmiUimFileType specified at val.

val :

a QmiUimFileType.

Returns :

a string with the nickname, or NULL if not found. Do not free the returned value. [transfer none]

qmi_uim_security_attribute_logic_get_string ()

const gchar *       qmi_uim_security_attribute_logic_get_string
                                                        (QmiUimSecurityAttributeLogic val);

Gets the nickname string for the QmiUimSecurityAttributeLogic specified at val.

val :

a QmiUimSecurityAttributeLogic.

Returns :

a string with the nickname, or NULL if not found. Do not free the returned value. [transfer none]

qmi_uim_security_attribute_build_string_from_mask ()

gchar *             qmi_uim_security_attribute_build_string_from_mask
                                                        (QmiUimSecurityAttribute mask);

Builds a string containing a comma-separated list of nicknames for each QmiUimSecurityAttribute in mask.

mask :

bitmask of QmiUimSecurityAttribute values.

Returns :

a string with the list of nicknames, or NULL if none given. The returned value should be freed with g_free(). [transfer full]

qmi_uim_card_state_get_string ()

const gchar *       qmi_uim_card_state_get_string       (QmiUimCardState val);

Gets the nickname string for the QmiUimCardState specified at val.

val :

a QmiUimCardState.

Returns :

a string with the nickname, or NULL if not found. Do not free the returned value. [transfer none]

qmi_uim_card_error_get_string ()

const gchar *       qmi_uim_card_error_get_string       (QmiUimCardError val);

Gets the nickname string for the QmiUimCardError specified at val.

val :

a QmiUimCardError.

Returns :

a string with the nickname, or NULL if not found. Do not free the returned value. [transfer none]

qmi_uim_pin_state_get_string ()

const gchar *       qmi_uim_pin_state_get_string        (QmiUimPinState val);

Gets the nickname string for the QmiUimPinState specified at val.

val :

a QmiUimPinState.

Returns :

a string with the nickname, or NULL if not found. Do not free the returned value. [transfer none]

qmi_uim_card_application_type_get_string ()

const gchar *       qmi_uim_card_application_type_get_string
                                                        (QmiUimCardApplicationType val);

Gets the nickname string for the QmiUimCardApplicationType specified at val.

val :

a QmiUimCardApplicationType.

Returns :

a string with the nickname, or NULL if not found. Do not free the returned value. [transfer none]

qmi_uim_card_application_state_get_string ()

const gchar *       qmi_uim_card_application_state_get_string
                                                        (QmiUimCardApplicationState val);

Gets the nickname string for the QmiUimCardApplicationState specified at val.

val :

a QmiUimCardApplicationState.

Returns :

a string with the nickname, or NULL if not found. Do not free the returned value. [transfer none]

qmi_uim_card_application_personalization_state_get_string ()

const gchar *       qmi_uim_card_application_personalization_state_get_string
                                                        (QmiUimCardApplicationPersonalizationState val);

Gets the nickname string for the QmiUimCardApplicationPersonalizationState specified at val.

val :

a QmiUimCardApplicationPersonalizationState.

Returns :

a string with the nickname, or NULL if not found. Do not free the returned value. [transfer none]

qmi_uim_card_application_personalization_feature_get_string ()

const gchar *       qmi_uim_card_application_personalization_feature_get_string
                                                        (QmiUimCardApplicationPersonalizationFeature val);

Gets the nickname string for the QmiUimCardApplicationPersonalizationFeature specified at val.

val :

a QmiUimCardApplicationPersonalizationFeature.

Returns :

a string with the nickname, or NULL if not found. Do not free the returned value. [transfer none]

qmi_uim_pin_id_get_string ()

const gchar *       qmi_uim_pin_id_get_string           (QmiUimPinId val);

Gets the nickname string for the QmiUimPinId specified at val.

val :

a QmiUimPinId.

Returns :

a string with the nickname, or NULL if not found. Do not free the returned value. [transfer none]