lineGetGeneralInfo (Compact 2013)

3/26/2014

Use the lineGetGeneralInfo function to retrieve general device information about the radio hardware, the radio software, the serial number, subscriber identity, and other information.


LONG WINAPI lineGetGeneralInfo(
  HLINE hLine,
  LPLINEGENERALINFO lpLineGeneralInfo
);

hLine

The line device handle. The line device handle must have been previously obtained by a call to lineOpen with the proper TAPI device ID specified and a device-specific extension version successfully negotiated with lineNegotiateExtVersion.

lpLineGeneralInfo

Points to a LINEGENERALINFO structure that provides information about the radio module manufacturer, version number, and other information.

Returns zero if the function completes successfully, or a negative error number if an error occurs. The following are possible return values:

  • LINEERR_RESOURCEUNAVAIL
  • LINEERR_INVALLINEHANDLE
  • LINEERR_STRUCTURETOOSMALL
  • LINEERR_INVALPOINTER
  • LINEERR_UNINITIALIZED
  • LINEERR_NOMEM
  • LINEERR_OPERATIONUNAVAIL
  • LINEERR_OPERATIONFAILED

This function is synchronous. No LINE_REPLY message is sent. When lineGetGeneralInfo runs, TAPI calls RIL_GetEquipmentInfo, and then RIL_GetUserIdentity. Neither RIL_GetEquipmentInfo nor RIL_GetUserIdentity return the subscriber number. To get the subscriber number for GSM and CDMA devices, use the lineGetAddressID function.

The support for this function varies on CDMA devices. For lineGetGeneralInfo to complete successfully on a CDMA device, the device's RIL driver must support the RIL_GetUserIdentity and RIL_GetEquipmentInfo functions.

This function can be used to retrieve the Electronic Serial Number (ESN) from a CDMA device. Typically, the ESN is part of the LINEGENERALINFO structure and is represented as an eight digit hexadecimal number beginning at the dwSerialNumberOffset.

For more information on the RIL functions, see RIL_GetUserIdentity and RIL_GetEquipmentInfo.

Header

extapi.h

Library

cellcore.lib

Show: