lineGetOperatorStatus

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

Use the lineGetOperatorStatus function to retrieve the lists of preferred and available operators. The preferred operator list is stored locally on the device and automatic registration iterates through this list when attempting to register. The available list shows which network operators are currently in range of the device. To obtain the current operator, use lineGetCurrentOperator.

Syntax

LONG WINAPI lineGetOperatorStatus(
  HLINE hLine,
  LPLINEOPERATORSTATUS lpOperatorStatus
);

Parameters

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

• lpOperatorStatus
  Points to a variably sized data structure of type LINEOPERATORSTATUS. See the LINEOPERATOR structure for possible values.

Return Value

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

Remarks

Prior to first calling lineGetOperatorStatus, the application should set the dwTotalSize member of the LINEOPERATORSTATUS structure passed as the lpOperatorStatus parameter to 0 (zero). This will return the size, in bytes, of memory needed to store the data returned by subsequently calling this function.

This function is synchronous. No LINE_REPLY message is sent and the application can use the contents of the parameter structures immediately after this function returns. Not implemented for CDMA.

Requirements

See Also

Reference

Extended TAPI Functions
lineGetCurrentOperator
LINEOPERATOR
LINEOPERATORSTATUS