Win32_POTSModem

The Win32_POTSModem class represents the services and characteristics of a Plain Old Telephone Service (POTS) modem on a Win32 system.

Quick Start

Properties

In this WMI class, all WMI properties are read-only. You can only read values but not change them.

AnswerMode

Data type UInt16

Answer mode defines the current auto-answer/call-back setting for the modem.

AttachedTo

Data type String

The AttachedTo property indicates the port to which the POTS modem is attached.

Example: COM1.

Availability

Data type UInt16

The availability and status of the device. For example, the Availability property indicates that the device is running and has full power (value=3), or is in a warning (4), test (5), degraded (10) or power save state (values 13-15 and 17). Regarding the power saving states, these are defined as follows: Value 13 (“Power Save – Unknown”) indicates that the device is known to be in a power save mode, but its exact status in this mode is unknown; 14 (“Power Save – Low Power Mode”) indicates that the device is in a power save state but still functioning, and may exhibit degraded performance; 15 (“Power Save – Standby”) describes that the device is not functioning but could be brought to full power ‘quickly’; and value 17 (“Power Save – Warning”) indicates that the device is in a warning state, though also in a power save mode.

$Availability_ReturnValue = 
@{
    1='Other'
    2='Unknown'
    3='Running/Full Power'
    4='Warning'
    5='In Test'
    6='Not Applicable'
    7='Power Off'
    8='Off Line'
    9='Off Duty'
   10='Degraded'
   11='Not Installed'
   12='Install Error'
   13='Power Save - Unknown'
   14='Power Save - Low Power Mode'
   15='Power Save - Standby'
   16='Power Cycle'
   17='Power Save - Warning'
   18='Paused'
   19='Not Ready'
   20='Not Configured'
   21='Quiesced'
}

BlindOff

Data type String

The BlindOff property contains the command string used to detect a dial tone before dialing.

Example: X4.

BlindOn

Data type String

The BlindOn property contains the command string used to dial whether or not there is a dial tone.

Example: X3.

Caption

Data type String

The Caption property is a short textual description (one-line string) of the object.

CompatibilityFlags

Data type String

The CompatibilityFlags property lists all modem connection protocols with which this modem device is compatible.

CompressionInfo

Data type UInt16

Describes the data compression characteristics of the modem.

CompressionOff

Data type String

The CompressionOff property contains the command string used to disable hardware data compression.

Example: S46=136.

CompressionOn

Data type String

The CompressionOn property contains the command string used to enable hardware data compression.

Example: S46=138.

ConfigManagerErrorCode

Data type UInt32

Indicates the Win32 Configuration Manager error code. The following values may be returned:

0 This device is working properly.

1 This device is not configured correctly.

2 Windows cannot load the driver for this device.

3 The driver for this device might be corrupted, or your system may be running low on memory or other resources.

4 This device is not working properly. One of its drivers or your registry might be corrupted.

5 The driver for this device needs a resource that Windows cannot manage.

6 The boot configuration for this device conflicts with other devices.

7 Cannot filter.

8 The driver loader for the device is missing.

9 This device is not working properly because the controlling firmware is reporting the resources for the device incorrectly.

10 This device cannot start.

11 This device failed.

12 This device cannot find enough free resources that it can use.

13 Windows cannot verify this device’s resources.

14 This device cannot work properly until you restart your computer.

15 This device is not working properly because there is probably a re-enumeration problem.

16 Windows cannot identify all the resources this device uses.

17 This device is asking for an unknown resource type.

18 Reinstall the drivers for this device.

19 Your registry might be corrupted.

20 Failure using the VxD loader.

21 System failure: Try changing the driver for this device. If that does not work, see your hardware documentation. Windows is removing this device.

22 This device is disabled.

23 System failure: Try changing the driver for this device. If that doesn’t work, see your hardware documentation.

24 This device is not present, is not working properly, or does not have all its drivers installed.

25 Windows is still setting up this device.

26 Windows is still setting up this device.

27 This device does not have valid log configuration.

28 The drivers for this device are not installed.

29 This device is disabled because the firmware of the device did not give it the required resources.

30 This device is using an Interrupt Request (IRQ) resource that another device is using.

31 This device is not working properly because Windows cannot load the drivers required for this device.

$ConfigManagerErrorCode_ReturnValue = 
@{
    0='This device is working properly.'
    1='This device is not configured correctly.'
    2='Windows cannot load the driver for this device.'
    3='The driver for this device might be corrupted    4= or your system may be running low on memory or other resources.'

    5='This device is not working properly. One of its drivers or your registry might be corrupted.'
    6='The driver for this device needs a resource that Windows cannot manage.'
    7='The boot configuration for this device conflicts with other devices.'
    8='Cannot filter.'
    9='The driver loader for the device is missing.'
   10='This device is not working properly because the controlling firmware is reporting the resources for the device incorrectly.'
   11='This device cannot start.'
   12='This device failed.'
   13='This device cannot find enough free resources that it can use.'
   14='Windows cannot verify this device's resources.'    15='This device cannot work properly until you restart your computer.'    16='This device is not working properly because there is probably a re-enumeration problem.'    17='Windows cannot identify all the resources this device uses.'    18='This device is asking for an unknown resource type.'    19='Reinstall the drivers for this device.'    20='Failure using the VxD loader.'    21='Your registry might be corrupted.'    22='System failure: Try changing the driver for this device. If that does not work
   23= see your hardware documentation. Windows is removing this device.'    24='This device is disabled.'    25='System failure: Try changing the driver for this device. If that doesn't work    26= see your hardware documentation.'
   27='This device is not present   28= is not working properly
   29= or does not have all its drivers installed.'

   30='Windows is still setting up this device.'
   31='Windows is still setting up this device.'
}

ConfigManagerUserConfig

Data type Boolean

Indicates whether the device is using a user-defined configuration.

ConfigurationDialog

Data type String

The ConfigurationDialog property contains the modem initialization string. This property is comprised of command strings from other members of this class.

CountriesSupported

Data type String

CountriesSupported is an array (bag) that contains a set of strings defining the countries/regions in which the modem can operate.

CountrySelected

Data type String

CountrySelected is a string value defining the country/region for which the modem is currently programmed. When multiple countries/regions are supported, this property defines which one is currently selected for use.

CreationClassName

Data type String

CreationClassName indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.

CurrentPasswords

Data type String

CurrentPasswords is an array (bag) containing the currently defined passwords for the modem. This array may be left blank for security reasons.

DCB

Data type UInt8

The Device Control Block (DCB) property contains the control settings for a serial communications device, in this case, the modem device.

Default

Data type UInt8

The Default property indicates whether this POTS modem is the default modem on the Win32 computer system.

Description

Data type String

The Description parameter specifies a comment describing the node.

DeviceID

Data type String

The DeviceID property contains a string uniquely identifying this POTS modem from other devices on the system.

DeviceLoader

Data type String

The DeviceLoader property indicates the name of the device loader for the modem. A device loader loads and manages device drivers and enumerators for a given device.

DeviceType

Data type String

The DeviceType property indicates the physical type of the modem.

'Null Modem','Internal Modem','External Modem','PCMCIA Modem','Unknown'

DfsEntryPath

Data type String

The DfsEntryPath parameter specifies the path of the DFS root.

DialType

Data type UInt16

DialType is an integer indicating whether tone (value=1) or pulse dialing (value=2) is used. “Unknown” (0) can also be defined.

DriverDate

Data type DateTime

The DriverDate property indicates the date of the modem driver.

ErrorCleared

Data type Boolean

ErrorCleared is a boolean property indicating that the error reported in LastErrorCode property is now cleared.

ErrorControlForced

Data type String

The ErrorControlForced property contains the command string used to enable error correction control when establishing a connection. This increases the reliability of the connection.

Example: +Q5S36=4S48=7.

ErrorControlInfo

Data type UInt16

Describes the error correction characteristics of the modem.

ErrorControlOff

Data type String

The ErrorControlOff property contains the command string used to disable error control.

Example: +Q6S36=3S48=128.

ErrorControlOn

Data type String

The ErrorControlOn property contains the command string used to enable error control.

Example: +Q5S36=7S48=7.

ErrorDescription

Data type String

ErrorDescription is a free-form string supplying more information about the error recorded in LastErrorCode property, and information on any corrective actions that may be taken.

FlowControlHard

Data type String

The FlowControlHard property contains the command string used to enable hardware flow control. Flow control consists of signals sent between computers that verify that both computers are ready to transmit or receive data.

Example: &K1.

FlowControlOff

Data type String

The FlowControlOff property contains the command string used to disable flow control. Flow control consists of signals sent between computers that verify that both computers are ready to transmit or receive data.

Example: &K0.

FlowControlSoft

Data type String

The FlowControlSoft property contains the command string used to enable software flow control. Flow control consists of signals sent between computers that verify that both computers are ready to transmit or receive data.

Example: &K2.

InactivityScale

Data type String

The InactivityScale property is a multiplier used with the InactivityTimeout property to calculate the timeout period of a connection.

InactivityTimeout

Data type UInt32

InactivityTimeout defines the time limit (in seconds) for automatic disconnection of the phone line, if no data is exchanged. A value of 0 indicates that this feature is present but not enabled.

Index

Data type UInt32

The Index property indicates the index number for this POTS modem.

Example: 0

InstallDate

Data type DateTime

The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

LastErrorCode

Data type UInt32

LastErrorCode captures the last error code reported by the logical device.

MaxBaudRateToPhone

Data type UInt32

Defines the maximum settable communication speed for accessing the phone system.

MaxBaudRateToSerialPort

Data type UInt32

Defines the maximum settable communication speed to the COM port for an external modem. Enter 0 if not applicable.

MaxNumberOfPasswords

Data type UInt16

MaxNumberOfPasswords specifies the number of passwords definable in the modem itself. If this feature is not supported, enter 0.

Model

Data type String

The Model property indicates the model of this POTS modem.

Example: Sportster 56K External.

ModemInfPath

Data type String

The ModemInfPath property indicates the path to this modem’s .inf file. This file contains initialization information for the modem and its driver.

Example: C:\WINNT\INF.

ModemInfSection

Data type String

The ModemInfSection property indicates the name of the section in the modem’s .inf file that contains information about the modem.

ModulationBell

Data type String

The ModulationBell property contains the command string used to instruct the modem to use Bell modulations for 300 and 1200 bps.

Example: B1.

ModulationCCITT

Data type String

The ModulationCCITT property contains the command string used to instruct the modem to use CCITT modulations for 300 and 1200 bps.

Example: B0.

ModulationScheme

Data type UInt16

Describes the modulation scheme of the modem.

Name

Data type String

The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.

PNPDeviceID

Data type String

Indicates the Win32 Plug and Play device ID of the logical device. Example: *PNP030b

PortSubClass

Data type String

The PortSubClass property contains the string definingthe port used for this modem.

$PortSubClass_ReturnValue = 
@{
   00=
   01='(unknown)'
   02='(unknown)'
}

PowerManagementCapabilities

Data type UInt16

Indicates the specific power-related capabilities of the logical device. The array values, 0=”Unknown”, 1=”Not Supported” and 2=”Disabled” are self-explanatory. The value, 3=”Enabled” indicates that the power management features are currently enabled but the exact feature set is unknown or the information is unavailable. “Power Saving Modes Entered Automatically” (4) describes that a device can change its power state based on usage or other criteria. “Power State Settable” (5) indicates that the SetPowerState method is supported. “Power Cycling Supported” (6) indicates that the SetPowerState method can be invoked with the PowerState input variable set to 5 (“Power Cycle”). “Timed Power On Supported” (7) indicates that the SetPowerState method can be invoked with the PowerState input variable set to 5 (“Power Cycle”) and the Time parameter set to a specific date and time, or interval, for power-on.

PowerManagementSupported

Data type Boolean

Boolean indicating that the Device can be power managed – ie, put into a power save state. This boolean does not indicate that power management features are currently enabled, or if enabled, what features are supported. Refer to the PowerManagementCapabilities array for this information. If this boolean is $false, the integer value 1, for the string, “Not Supported”, should be the only entry in the PowerManagementCapabilities array.

Prefix

Data type String

The Prefix property indicates the dialing prefix used to access an outside line.

Properties

Data type UInt8

The Properties property is a string array that lists all the properties (and their values) for this modem.

ProviderName

Data type String

The ProviderName property indicates the network path to the computer that provides the modem services.

Pulse

Data type String

The Pulse property contains the command string used to instruct the modem to use pulse mode for dialing. Pulse dialing is necessary for phone lines that are unable to handle tone dialing.

Example: P.

Reset

Data type String

The Reset property contains the command string used to reset the modem for the next call.

Example: AT&F.

ResponsesKeyName

Data type String

The ResponsesKeyName property contains the response this modem might report to the operating system during the connection process. The first two characters specify the type of response. The second two characters specify information about the connection being made. The second two characters are used only for Negotiation Progress or Connect response codes. The next eight characters specify the modem-to-modem line speed negotiated in bits per second (bps). The characters represent a 32-bit integer doubleword format (byte and word reversed). The last eight characters indicate that the modem is changing to a different port or Data Terminal Equipment (DTE) speed. Usually this field is not used because modems make connections at a “locked” port speed regardless of the modem-to-modem or Data Communications Equipment (DCE) speed.

RingsBeforeAnswer

Data type UInt8

Number of rings before the modem answers an incoming call.

ServerName

Data type String

The ServerName parameter specifies the name of the server that hosts the share to which the link is associated. For example, in order to create a link associated to a share “\\myserver\myshare”, the ServerName parameter should be set to “\\myserver”.

ShareName

Data type String

The ShareName parameter specifies the name of the share to which the link is associated with. For example, in order to create a link associated to a share “\\myserver\myshare”, the ShareName parameter should be set to “myshare”.

SpeakerModeDial

Data type String

The SpeakerModeDial property contains the command string used to turn the modem speaker on after dialing a number, and turning the speaker off when a connection has been established.

Example: M1.

SpeakerModeOff

Data type String

The SpeakerModeOff property contains the command string used to turn the modem speaker off.

Example: M0.

SpeakerModeOn

Data type String

The SpeakerModeOn property contains the command string used to turn the modem speaker on.

Example: M2.

SpeakerModeSetup

Data type String

The SpeakerModeSetup property contains the command string used to instruct the modem to turn the speaker on (until a connection is established).

Example: M3.

SpeakerVolumeHigh

Data type String

The SpeakerVolumeHigh property contains the command string used to set the modem speaker to the highest volume.

Example: L3.

SpeakerVolumeInfo

Data type UInt16

Describes the volume level of the audible tones from the modem. For example, high, medium or low volume can be reported (values 3, 4 or 5, respectively).

SpeakerVolumeLow

Data type String

The SpeakerVolumeLow property contains the command string used to set the modem speaker to the lowest volume.

Example: L1.

SpeakerVolumeMed

Data type String

The SpeakerVolumeMed property contains the command string used to set the modem speaker to a medium volume.

Example: L2.

Status

Data type String

The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are “OK”, “Degraded” and “Pred Fail”. “Pred Fail” indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are “Error”, “Starting”, “Stopping” and “Service”. The latter, “Service”, could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither “OK” nor in one of the other states.

'OK','Error','Degraded','Unknown','Pred Fail','Starting','Stopping','Service','Stressed','NonRecover','No Contact','Lost Comm'

StatusInfo

Data type UInt16

StatusInfo is a string indicating whether the logical device is in an enabled (value = 3), disabled (value = 4) or some other (1) or unknown (2) state. If this property does not apply to the logical device, the value, 5 (“Not Applicable”), should be used.

$StatusInfo_ReturnValue = 
@{
    1='Other'
    2='Unknown'
    3='Enabled'
    4='Disabled'
    5='Not Applicable'
}

StringFormat

Data type String

The StringFormat property describes the type of characters used for text passed through the modem.

SupportsCallback

Data type Boolean

Indication of whether the modem supports call-back

SupportsSynchronousConnect

Data type Boolean

Boolean indicating that synchronous, as well as asynchronous, communication is supported.

SystemCreationClassName

Data type String

The scoping System’s CreationClassName.

SystemName

Data type String

The scoping System’s Name.

Terminator

Data type String

The Terminator property contains the string that marks the end of a command string.

Example:

TimeOfLastReset

Data type DateTime

The TimeOfLastReset property indicates the date and time this controller was last reset. This could mean the controller was powered down, or reinitialized.

Tone

Data type String

The Tone property contains the command string that instructs the modem to use tone mode for dialing. The phone line must support tone dialing.

Example: T.

VoiceSwitchFeature

Data type String

The VoiceSwitchFeature property contains the command strings used to activate the voice capabilities of a voice modem.

Example: AT+V.

Methods

Examples

See Also

Help and Questions

  Community Content

You are cordially invited to add knowledge to this page. If you have sample code or additional information related to this WMI class, please share it. Use the comment form to send your information. We will edit and incorparate it into the reference library. Thank you!

Please do not use the comment form to submit questions. If you have questions or need assistance, visit our free forum: Help me with WMI.

Content last updated: 2013-12-27 12:17:28 (UTC).

Facebooktwittergoogle_pluspinterestlinkedinFacebooktwittergoogle_pluspinterestlinkedin