Share via


lineGetCallBarringState (Compact 2013)

3/26/2014

Use the lineGetCallBarringState function to retrieve the current barring state for a given mode.

Syntax

LONG WINAPI lineGetCallBarringState(
  HLINE hLine,
  DWORD dwMode,
  LPDWORD lpdwClasses,
  LPCTSTR lpszPassword
);

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.
  • dwMode
    Indicates which barring mode the application needs status on.
  • lpdwClasses
    Points to a bit field DWORD indicating which media modes are currently barred. See the Barring Modes constants for possible values.
  • lpszPassword
    A password may be necessary to read the current barring status.

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_INCORRECTPASSWORD
  • LINEERR_RESOURCEUNAVAIL
  • LINEERR_INVALLINEHANDLE
  • LINEERR_STRUCTURETOOSMALL
  • LINEERR_INVALPOINTER
  • LINEERR_UNINITIALIZED
  • LINEERR_NOMEM
  • LINEERR_OPERATIONUNAVAIL
  • LINEERR_OPERATIONFAILED

Remarks

This function is synchronous. No LINE_REPLY message is sent. Not implemented for CDMA.

Requirements

Header

extapi.h

Library

cellcore.lib

See Also

Reference

Extended TAPI Functions
Barring Modes