Win32_POTSModem class
Applies to: desktop apps only
The Win32_POTSModem WMI class represents the services and characteristics of a Plain Old Telephone Service (POTS) modem on a computer system running Windows.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties. Properties are listed in alphabetic order, not MOF order.
Syntax
class Win32_POTSModem : CIM_PotsModem
{
uint16 AnswerMode;
string AttachedTo;
uint16 Availability;
string BlindOff;
string BlindOn;
string Caption;
string CompatibilityFlags;
uint16 CompressionInfo;
string CompressionOff;
string CompressionOn;
uint32 ConfigManagerErrorCode;
boolean ConfigManagerUserConfig;
string ConfigurationDialog;
string CountriesSupported[];
string CountrySelected;
string CreationClassName;
string CurrentPasswords[];
uint8 DCB[];
uint8 Default[];
string Description;
string DeviceID;
string DeviceLoader;
string DeviceType;
uint16 DialType;
datetime DriverDate;
boolean ErrorCleared;
string ErrorControlForced;
uint16 ErrorControlInfo;
string ErrorControlOff;
string ErrorControlOn;
string ErrorDescription;
string FlowControlHard;
string FlowControlOff;
string FlowControlSoft;
string InactivityScale;
uint32 InactivityTimeout;
uint32 Index;
datetime InstallDate;
uint32 LastErrorCode;
uint32 MaxBaudRateToPhone;
uint32 MaxBaudRateToSerialPort;
uint16 MaxNumberOfPasswords;
string Model;
string ModemInfPath;
string ModemInfSection;
string ModulationBell;
string ModulationCCITT;
uint16 ModulationScheme;
string Name;
string PNPDeviceID;
string PortSubClass;
uint16 PowerManagementCapabilities[];
boolean PowerManagementSupported;
string Prefix;
uint8 Properties[];
string ProviderName;
string Pulse;
string Reset;
string ResponsesKeyName;
uint8 RingsBeforeAnswer;
string SpeakerModeDial;
string SpeakerModeOff;
string SpeakerModeOn;
string SpeakerModeSetup;
string SpeakerVolumeHigh;
uint16 SpeakerVolumeInfo;
string SpeakerVolumeLow;
string SpeakerVolumeMed;
string Status;
uint16 StatusInfo;
string StringFormat;
boolean SupportsCallback;
boolean SupportsSynchronousConnect;
string SystemCreationClassName;
string SystemName;
string Terminator;
datetime TimeOfLastReset;
string Tone;
string VoiceSwitchFeature;
};
Members
The Win32_POTSModem class has these types of members:
Methods
The Win32_POTSModem class has these methods.
| Method | Description |
|---|---|
| Reset |
Not implemented. To implement this method, see the Reset method in CIM_PotsModem. |
| SetPowerState |
Not implemented. To implement this method, see the SetPowerState method in CIM_PotsModem. |
Properties
The Win32_POTSModem class has these properties.
- AnswerMode
-
- Data type: uint16
- Access type: Read-only
Current auto-answer or callback setting for the modem. This property is inherited from CIM_PotsModem.
Value Meaning - 1
Unknown
- 2
Other
- 3
Disabled
- 4
Manual Answer
- 5
Auto Answer
- 6
Auto Answer with Callback
- AttachedTo
-
- Data type: string
- Access type: Read-only
Port to which the POTS modem is attached.
Example: "COM1"
- Availability
-
- Data type: uint16
- Access type: Read-only
Availability and status of the device. Inherited from CIM_LogicalDevice.
Value Meaning - 1 (0x1)
Other
- 2 (0x2)
Unknown
- 3 (0x3)
Running or Full Power
- 4 (0x4)
Warning
- 5 (0x5)
In Test
- 6 (0x6)
Not Applicable
- 7 (0x7)
Power Off
- 8 (0x8)
Off Line
- 9 (0x9)
Off Duty
- 10 (0xA)
Degraded
- 11 (0xB)
Not Installed
- 12 (0xC)
Install Error
- 13 (0xD)
Power Save - Unknown
The device is known to be in a power save mode, but its exact status is unknown.
- 14 (0xE)
Power Save - Low Power Mode
The device is in a power save state but still functioning, and may exhibit degraded performance.
- 15 (0xF)
Power Save - Standby
The device is not functioning, but could be brought to full power quickly.
- 16 (0x10)
Power Cycle
- 17 (0x11)
Power Save - Warning
The device is in a warning state, though also in a power save mode.
- BlindOff
-
- Data type: string
- Access type: Read-only
Command string used to detect a dial tone before dialing.
Example: "X4"
- BlindOn
-
- Data type: string
- Access type: Read-only
Command string used to dial whether or not there is a dial tone.
Example: "X3"
- Caption
-
- Data type: string
- Access type: Read-only
- Qualifiers: MaxLen (64)
Short description of the object. This property is inherited from CIM_ManagedSystemElement.
- CompatibilityFlags
-
- Data type: string
- Access type: Read-only
All modem connection protocols with which this modem device is compatible.
- CompressionInfo
-
- Data type: uint16
- Access type: Read-only
Data compression characteristics of the modem. This property is inherited from CIM_PotsModem.
Value Meaning - 1
Unknown
- 2
Other
- 3
No Compression
- 4
MNP 5
- 5
V.42bis
- CompressionOff
-
- Data type: string
- Access type: Read-only
Command string used to disable hardware data compression.
Example: "S46=136"
- CompressionOn
-
- Data type: string
- Access type: Read-only
Command string used to enable hardware data compression.
Example: "S46=138"
- ConfigManagerErrorCode
-
- Data type: uint32
- Access type: Read-only
Win32 Configuration Manager error code.
Value Meaning - 0 (0x0)
Device is working properly.
- 1 (0x1)
Device is not configured correctly.
- 2 (0x2)
Windows cannot load the driver for this device.
- 3 (0x3)
Driver for this device might be corrupted, or the system may be low on memory or other resources.
- 4 (0x4)
Device is not working properly. One of its drivers or the registry might be corrupted.
- 5 (0x5)
Driver for the device requires a resource that Windows cannot manage.
- 6 (0x6)
Boot configuration for the device conflicts with other devices.
- 7 (0x7)
Cannot filter.
- 8 (0x8)
Driver loader for the device is missing.
- 9 (0x9)
Device is not working properly. The controlling firmware is incorrectly reporting the resources for the device.
- 10 (0xA)
Device cannot start.
- 11 (0xB)
Device failed.
- 12 (0xC)
Device cannot find enough free resources to use.
- 13 (0xD)
Windows cannot verify the device's resources.
- 14 (0xE)
Device cannot work properly until the computer is restarted.
- 15 (0xF)
Device is not working properly due to a possible re-enumeration problem.
- 16 (0x10)
Windows cannot identify all of the resources that the device uses.
- 17 (0x11)
Device is requesting an unknown resource type.
- 18 (0x12)
Device drivers must be reinstalled.
- 19 (0x13)
Failure using the VxD loader.
- 20 (0x14)
Registry might be corrupted.
- 21 (0x15)
System failure. If changing the device driver is ineffective, see the hardware documentation. Windows is removing the device.
- 22 (0x16)
Device is disabled.
- 23 (0x17)
System failure. If changing the device driver is ineffective, see the hardware documentation.
- 24 (0x18)
Device is not present, not working properly, or does not have all of its drivers installed.
- 25 (0x19)
Windows is still setting up the device.
- 26 (0x1A)
Windows is still setting up the device.
- 27 (0x1B)
Device does not have valid log configuration.
- 28 (0x1C)
Device drivers are not installed.
- 29 (0x1D)
Device is disabled. The device firmware did not provide the required resources.
- 30 (0x1E)
Device is using an IRQ resource that another device is using.
- 31 (0x1F)
Device is not working properly. Windows cannot load the required device drivers.
- ConfigManagerUserConfig
-
- Data type: boolean
- Access type: Read-only
If TRUE, the device is using a user-defined configuration. This property is inherited from CIM_LogicalDevice.
- ConfigurationDialog
-
- Data type: string
- Access type: Read-only
Modem initialization string. This property is made up of command strings from other properties of this class.
- CountriesSupported
-
- Data type: string array
- Access type: Read-only
Array of countries/regions in which the modem can operate. This property is inherited from CIM_PotsModem.
- CountrySelected
-
- Data type: string
- Access type: Read-only
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. This property is inherited from CIM_PotsModem.
- CreationClassName
-
- Data type: string
- Access type: Read-only
Name of the first concrete class to appear in the inheritance chain used in the creation of an instance. When used with the other key properties of the class, the property allows all instances of this class and its subclasses to be uniquely identified. This property is inherited from CIM_LogicalDevice.
- CurrentPasswords
-
- Data type: string array
- Access type: Read-only
List of currently defined passwords for the modem. This array may be left blank for security reasons. This property is inherited from CIM_PotsModem.
- DCB
-
- Data type: uint8 array
- Access type: Read-only
Control settings for a serial communications device, in this case, the modem device.
- Default
-
- Data type: uint8 array
- Access type: Read-only
If TRUE, this POTS modem is the default modem on the computer system running Windows.
- Description
-
- Data type: string
- Access type: Read-only
Description of the object. This property is inherited from CIM_ManagedSystemElement.
- DeviceID
-
- Data type: string
- Access type: Read-only
- Qualifiers: Key
Unique identifier of this POTS modem from other devices on the system. This property is inherited from CIM_LogicalDevice.
- DeviceLoader
-
- Data type: string
- Access type: Read-only
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
- Access type: Read-only
Physical type of the modem.
The values are:
- "Null Modem"
- "Internal Modem"
- "External Modem"
- "PCMCIA Modem"
- "Unknown"
- DialType
-
- Data type: uint16
- Access type: Read-only
Type of dialing method used. This property is inherited from CIM_PotsModem.
Value Meaning - 0
Unknown
- 1
Tone
- 2
Pulse
- DriverDate
-
- Data type: datetime
- Access type: Read-only
Date of the modem driver.
- ErrorCleared
-
- Data type: boolean
- Access type: Read-only
If TRUE, the error reported in LastErrorCode is now cleared. This property is inherited from CIM_LogicalDevice.
- ErrorControlForced
-
- Data type: string
- Access type: Read-only
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
- Access type: Read-only
Error correction characteristics of the modem. This property is inherited from CIM_PotsModem.
Value Meaning - 1
Unknown
- 2
Other
- 3
No Error Correction
- 4
MNP 4
- 5
LAPM
- ErrorControlOff
-
- Data type: string
- Access type: Read-only
Command string used to disable error control.
Example: "+Q6S36=3S48=128"
- ErrorControlOn
-
- Data type: string
- Access type: Read-only
Command string used to enable error control.
Example: "+Q5S36=7S48=7"
- ErrorDescription
-
- Data type: string
- Access type: Read-only
More information about the error recorded in LastErrorCode, and information on any corrective actions that may be taken. This property is inherited from CIM_LogicalDevice.
- FlowControlHard
-
- Data type: string
- Access type: Read-only
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
- Access type: Read-only
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
- Access type: Read-only
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
- Access type: Read-only
Multiplier used with the InactivityTimeout property to calculate the timeout period of a connection.
- InactivityTimeout
-
- Data type: uint32
- Access type: Read-only
- Qualifiers: Units (Seconds)
Time limit (in seconds) for automatic disconnection of the phone line, if no data is exchanged. A value of 0 (zero) indicates that this feature is present but not enabled. This property is inherited from CIM_PotsModem.
- Index
-
- Data type: uint32
- Access type: Read-only
Index number for this POTS modem.
Example: 0
- InstallDate
-
- Data type: datetime
- Access type: Read-only
Date and time the object was installed. This property does not need a value to indicate that the object is installed. This property is inherited from CIM_ManagedSystemElement.
- LastErrorCode
-
- Data type: uint32
- Access type: Read-only
Last error code reported by the logical device. This property is inherited from CIM_LogicalDevice.
- MaxBaudRateToPhone
-
- Data type: uint32
- Access type: Read-only
- Qualifiers: Units (Bits per second)
Maximum settable communication speed for accessing the phone system. This property is inherited from CIM_PotsModem.
- MaxBaudRateToSerialPort
-
- Data type: uint32
- Access type: Read-only
- Qualifiers: Units (Bits per second)
Maximum settable communication speed to the COM port for an external modem. Enter 0 (zero) if not applicable. This property is inherited from CIM_PotsModem.
- MaxNumberOfPasswords
-
- Data type: uint16
- Access type: Read-only
Number of passwords definable in the modem itself. If this feature is not supported, enter 0 (zero). This property is inherited from CIM_PotsModem.
- Model
-
- Data type: string
- Access type: Read-only
Model of this POTS modem.
Example: "Sportster 56K External"
- ModemInfPath
-
- Data type: string
- Access type: Read-only
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
- Access type: Read-only
Name of the section in the modem's .inf file that contains information about the modem.
- ModulationBell
-
- Data type: string
- Access type: Read-only
Command string used to instruct the modem to use Bell modulations for 300 and 1200 bps.
Example: "B1"
- ModulationCCITT
-
- Data type: string
- Access type: Read-only
Command string used to instruct the modem to use CCITT modulations for 300 and 1200 bps.
Example: "B0"
- ModulationScheme
-
- Data type: uint16
- Access type: Read-only
Modulation scheme of the modem. This property is inherited from CIM_PotsModem.
Value Meaning - 1
Unknown
- 2
Other
- 3
Not Supported
- 4
Bell 103
- 5
Bell 212A
- 6
V.22bis
- 7
V.32
- 8
V.32bis
- 9
V.turbo
- 10
V.FC
- 11
V.34
- 12
V.34bis
- Name
-
- Data type: string
- Access type: Read-only
Label by which the object is known. When subclassed, the property can be overridden to be a key property. This property is inherited from CIM_ManagedSystemElement.
- PNPDeviceID
-
- Data type: string
- Access type: Read-only
Windows Plug and Play device identifier of the logical device. This property is inherited from CIM_LogicalDevice.
Example: "*PNP030b"
- PortSubClass
-
- Data type: string
- Access type: Read-only
Definition of the port used for this modem.
Value Meaning - "00"
Parallel Port
- "01"
Serial Port
- "02"
Modem
- PowerManagementCapabilities
-
- Data type: uint16 array
- Access type: Read-only
Array of the specific power-related capabilities of a logical device. This property is inherited from CIM_LogicalDevice.
Value Meaning - 0 (0x0)
Unknown
- 1 (0x1)
Not Supported
- 2 (0x2)
Disabled
- 3 (0x3)
Enabled
The power management features are currently enabled but the exact feature set is unknown or the information is unavailable.
- 4 (0x4)
Power Saving Modes Entered Automatically
The device can change its power state based on usage or other criteria.
- 5 (0x5)
Power State Settable
The SetPowerState method is supported. This method is found on the parent CIM_LogicalDevice class and can be implemented. For more information, see Designing Managed Object Format (MOF) Classes.
- 6 (0x6)
Power Cycling Supported
The SetPowerState method can be invoked with the PowerState parameter set to 5 (Power Cycle).
- 7 (0x7)
Timed Power-On Supported
The SetPowerState method can be invoked with the PowerState parameter set to 5 (Power Cycle) and Time set to a specific date and time, or interval, for power-on.
- PowerManagementSupported
-
- Data type: boolean
- Access type: Read-only
If TRUE, the device can be power-managed (can be put into suspend mode, and so on). The property does not indicate that power management features are currently enabled, only that the logical device is capable of power management. This property is inherited from CIM_LogicalDevice.
- Prefix
-
- Data type: string
- Access type: Read-only
Dialing prefix used to access an outside line.
- Properties
-
- Data type: uint8 array
- Access type: Read-only
List of all the properties (and their values) for this modem.
- ProviderName
-
- Data type: string
- Access type: Read-only
Network path to the computer that provides the modem services.
- Pulse
-
- Data type: string
- Access type: Read-only
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
- Access type: Read-only
Command string used to reset the modem for the next call.
Example: "AT&F"
- ResponsesKeyName
-
- Data type: string
- Access type: Read-only
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 unsigned long integer 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
- Access type: Read-only
Number of rings before the modem answers an incoming call. This property is inherited from CIM_PotsModem.
- SpeakerModeDial
-
- Data type: string
- Access type: Read-only
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
- Access type: Read-only
Command string used to turn the modem speaker off.
Example: "M0"
- SpeakerModeOn
-
- Data type: string
- Access type: Read-only
Command string used to turn the modem speaker on.
Example: "M2"
- SpeakerModeSetup
-
- Data type: string
- Access type: Read-only
Command string used to instruct the modem to turn the speaker on (until a connection is established).
Example: "M3"
- SpeakerVolumeHigh
-
- Data type: string
- Access type: Read-only
Command string used to set the modem speaker to the highest volume.
Example: "L3"
- SpeakerVolumeInfo
-
- Data type: uint16
- Access type: Read-only
Describes the volume level of the audible tones from the modem. This property is inherited from CIM_PotsModem.
Value Meaning - 0
Unknown
- 1
Other
- 2
Not Supported
- 3
High
- 4
Medium
- 5
Low
- 6
Off
- 7
Auto
- SpeakerVolumeLow
-
- Data type: string
- Access type: Read-only
Command string used to set the modem speaker to the lowest volume.
Example: "L1"
- SpeakerVolumeMed
-
- Data type: string
- Access type: Read-only
Command string used to set the modem speaker to a medium volume.
Example: "L2"
- Status
-
- Data type: string
- Access type: Read-only
- Qualifiers: MaxLen (10)
Current status of the object. Various operational and nonoperational statuses can be defined. Operational statuses include: "OK", "Degraded", and "Pred Fail" (an element, such as a SMART-enabled hard disk drive, may be functioning properly but predicting a failure in the near future). Nonoperational statuses include: "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 online, yet the managed element is neither "OK" nor in one of the other states. This property is inherited from CIM_ManagedSystemElement.
The values are:
- "OK"
- "Error"
- "Degraded"
- "Unknown"
- "Pred Fail"
- "Starting"
- "Stopping"
- "Service"
- "Stressed"
- "NonRecover"
- "No Contact"
- "Lost Comm"
- StatusInfo
-
- Data type: uint16
- Access type: Read-only
State of the logical device. If this property does not apply to the logical device, the value 5 (Not Applicable) should be used. This property is inherited from CIM_LogicalDevice.
Value Meaning - 1
Other
- 2
Unknown
- 3
Enabled
- 4
Disabled
- 5
Not Applicable
- StringFormat
-
- Data type: string
- Access type: Read-only
Type of characters used for text passed through the modem.
The values are:
- "ASCII string format"
- "DBCS string format"
- "UNICODE string format"
- SupportsCallback
-
- Data type: boolean
- Access type: Read-only
If TRUE, the modem supports callback. This property is inherited from CIM_PotsModem.
- SupportsSynchronousConnect
-
- Data type: boolean
- Access type: Read-only
If TRUE, synchronous, as well as asynchronous, communication is supported. This property is inherited from CIM_PotsModem.
- SystemCreationClassName
-
- Data type: string
- Access type: Read-only
Value of the scoping computer's CreationClassName property. This property is inherited from CIM_LogicalDevice.
- SystemName
-
- Data type: string
- Access type: Read-only
Name of the scoping system. This property is inherited from CIM_LogicalDevice.
- Terminator
-
- Data type: string
- Access type: Read-only
String that marks the end of a command string.
Example: "<cr"
- TimeOfLastReset
-
- Data type: datetime
- Access type: Read-only
Date and time the modem was last reset. This property is inherited from CIM_PotsModem.
- Tone
-
- Data type: string
- Access type: Read-only
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
- Access type: Read-only
Command strings used to activate the voice capabilities of a voice modem.
Example: "AT+V"
Remarks
The Win32_POTSModem class is derived from CIM_PotsModem.
Examples
For script code examples, see WMI Tasks for Scripts and Applications and the TechNet ScriptCenter Script Repository.
For C++ code examples, see WMI C++ Application Examples.
Requirements
|
Minimum supported client | Windows 2000 Professional |
|---|---|
|
Minimum supported server | Windows 2000 Server |
|
Namespace |
\root\CIMV2 |
|
MOF |
|
|
DLL |
|
See also
Send comments about this topic to Microsoft
Build date: 3/9/2012
