SIMPHONEBOOKENTRYEX (Compact 2013)

3/26/2014

The SIMPHONEBOOKENTRYEX structure supports an extended SIM phonebook entry. This structure is part of the SIM Manager API set that enables access to information stored on SIM and USIM cards.

Syntax

typedef struct simphonebookentryex_tag {
  DWORD cbSize;
  DWORD dwParams;
  TCHAR lpszAddress[MAX_LENGTH_ADDRESS];
  DWORD dwAddressType;
  DWORD dwNumPlan;
  TCHAR lpszText[MAX_LENGTH_PHONEBOOKENTRYTEXT];
  TCHAR lpszSecondName[MAX_LENGTH_PHONEBOOKENTRYTEXT];
  DWORD dwIndex;
  BOOL fHidden;
  DWORD dwGroupIdCount;
  DWORD rgdwGroupId[MAX_NUM_GROUPS];
  DWORD dwUid;
  DWORD dwAdditionalNumberCount;
  LPSIMPHONEBOOKADDITIONALNUMBER lpAdditionalNumbers;
  DWORD dwEmailCount;
  LPSIMPHONEBOOKEMAILADDRESS lpEmailAddresses;
} SIMPHONEBOOKENTRYEX, *LPSIMPHONEBOOKENTRYEX;

Members

• cbSize
  Size of the structure in bytes.

• dwParams
  Indicates valid parameter values.

  Name	Value	Description
  SIM_PARAM_PBEX_ADDRESS	0x00000001	lpszAddress field is valid
  SIM_PARAM_PBEX_ADDRESS_TYPE	0x00000002	dwAddressType field is valid
  SIM_PARAM_PBEX_NUMPLAN	0x00000004	dwNumPlan field is valid
  SIM_PARAM_PBEX_TEXT	0x00000008	lpszText field is valid
  SIM_PARAM_PBEX_SECONDNAME	0x00000010	lpszSecondName field is valid
  SIM_PARAM_PBEX_HIDDEN	0x00000020	fHidden field is valid
  SIM_PARAM_PBEX_GROUPIDCOUNT	0x00000040	dwGroupIdCount field is valid
  SIM_PARAM_PBEX_GROUPID	0x00000080	rgdwGroupId field is valid
  SIM_PARAM_PBEX_UID	0x00000100	dwUid field is valid
  SIM_PARAM_PBEX_ADDITIONALNUMCOUNT	0x00000200	dwAdditionalNumCount field is valid
  SIM_PARAM_PBEX_ADDITIONALNUMBERS	0x00000400	lpAdditionalNumbers field is valid
  SIM_PARAM_PBEX_EMAILCOUNT	0x00000800	dwEmailCount field is valid
  SIM_PARAM_PBEX_EMAILADDRESSES	0x00001000	lpEmailAddresses field is valid
  SIM_PARAM_PBEX_INDEX	0x00002000	dwIndex field is valid
  SIM_PARAM_PBEX_ALL	0x00003FFF	All fields are valid

• lpszAddress
  An array for the actual phone number.

• dwAddressType
  A SIM_ADDRTYPE constant.

  Value	Description
  SIM_ADDRTYPE_UNKNOWN	Unknown.
  SIM_ADDRTYPE_INTERNATIONAL	International number. Note   The address should be prefixed with a "+" (plus sign), if not already, before being displayed to the user. Likewise, when writing an entry to the SIM, this needs to be written correctly.
  SIM_ADDRTYPE_NATIONAL	National/Regional number.
  SIM_ADDRTYPE_NETWKSPECIFIC	Network specific number.
  SIM_ADDRTYPE_SUBSCRIBER	Subscriber number (protocol-specific).
  SIM_ADDRTYPE_ALPHANUM	Alphanumeric address.
  SIM_ADDRTYPE_ABBREV	Abbreviated number.

• dwNumPlan
  A SIM_NUMPLAN constant.

  Value	Description
  SIM_NUMPLAN_UNKNOWN	Unknown.
  SIM_NUMPLAN_TELEPHONE	ISDN/telephone numbering plan (E.164/E.163).
  SIM_NUMPLAN_DATA	Data numbering plan (X.121).
  SIM_NUMPLAN_TELEX	Telex numbering plan.
  SIM_NUMPLAN_NATIONAL	National/Regional numbering plan.
  SIM_NUMPLAN_PRIVATE	Private numbering plan.
  SIM_NUMPLAN_ERMES	ERMES numbering plan (ETSI DE/PS 3 01-3).

• lpszText**[MAX_LENGTH_PHONEBOOKENTRYTEXT]**
  Text associated with the entry.

• lpszSecondName**[MAX_LENGTH_PHONEBOOKENTRYTEXT]**
  Second text field associated with the entry.

• dwIndex
  Index of the entry.

• fHidden
  Indicates a hidden entry.

• dwGroupIdCount
  Count of valid group ID's.

• rgdwGroupId**[MAX_NUM_GROUPS]**
  Array of group ID's.

• dwUid
  Unique identifier of entry.

• dwAdditionalNumberCount
  Number of additional numbers in the array.

• lpAdditionalNumbers
  Pointer to an array of SIMPHONEBOOKADDITIONALNUMBER structures.

• dwEmailCount
  Number of email addresses in the array.

• lpEmailAddresses
  Pointer to an array of SIMPHONEBOOKEMAILADDRESS structures.

Requirements

Header

simmgr.h

See Also

Reference

SIM Manager Structures
SimReadPhonebookEntries
SimWritePhonebookEntryEx