Win32_NetworkProtocol class
The Win32_NetworkProtocol WMI class represents a protocol and its network characteristics on a Win32 computer system.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties. Properties and methods are in alphabetic order, not MOF order.
Syntax
class Win32_NetworkProtocol : CIM_LogicalElement
{
string Caption;
boolean ConnectionlessService;
string Description;
boolean GuaranteesDelivery;
boolean GuaranteesSequencing;
datetime InstallDate;
uint32 MaximumAddressSize;
uint32 MaximumMessageSize;
boolean MessageOriented;
uint32 MinimumAddressSize;
string Name;
boolean PseudoStreamOriented;
string Status;
boolean SupportsBroadcasting;
boolean SupportsConnectData;
boolean SupportsDisconnectData;
boolean SupportsEncryption;
boolean SupportsExpeditedData;
boolean SupportsFragmentation;
boolean SupportsGracefulClosing;
boolean SupportsGuaranteedBandwidth;
boolean SupportsMulticasting;
boolean SupportsQualityofService;
};
Members
The Win32_NetworkProtocol class has these types of members:
Properties
The Win32_NetworkProtocol class has these properties.
- Caption
-
- Data type: string
- Access type: Read-only
Short description of the object.
- ConnectionlessService
-
- Data type: boolean
- Access type: Read-only
Protocol supports connectionless service. A connectionless (datagram) service describes a communications protocol or transport in which data packets are routed independently of each other and may follow different routes and arrive in a different order from that in which they were sent. Conversely, a connection-oriented service provides a virtual circuit through which data packets are received in the same order they were transmitted. If the connection between computers fails, the application is notified.
- Description
-
- Data type: string
- Access type: Read-only
Description of the object.
- GuaranteesDelivery
-
- Data type: boolean
- Access type: Read-only
Protocol supports delivery of data packets. If this flag is FALSE, it is uncertain that all of the data sent will reach the intended destination.
- GuaranteesSequencing
-
- Data type: boolean
- Access type: Read-only
Protocol ensures that data will arrive in the order in which it was sent. Be aware that this characteristic does not ensure delivery of the data, only its order.
- InstallDate
-
- Data type: datetime
- Access type: Read-only
Object was installed. This property does not require a value to indicate that the object is installed.
- MaximumAddressSize
-
- Data type: uint32
- Access type: Read-only
- Qualifiers: Units (Characters)
Maximum length of a socket address supported by the protocol. Socket addresses may be items such as a URL (www.microsoft.com) or an IP address (130.215.24.1).
- MaximumMessageSize
-
- Data type: uint32
- Access type: Read-only
- Qualifiers: Units (Characters)
Maximum message size supported by the protocol. This is the maximum size of a message that can be sent from or received by the host. For protocols that do not support message framing, the actual maximum size of a message that can be sent to a given address may be less than this value.
- MessageOriented
-
- Data type: boolean
- Access type: Read-only
Protocol is message-oriented. A message-oriented protocol uses packets of data to transfer information. Conversely, stream-oriented protocols transfer data as a continuous stream of bytes.
- MinimumAddressSize
-
- Data type: uint32
- Access type: Read-only
- Qualifiers: Units (Characters)
Minimum length of a socket address supported by the protocol.
- Name
-
- Data type: string
- Access type: Read-only
- Qualifiers: Key
Name for the protocol.
Example: "TCP/IP"
- PseudoStreamOriented
-
- Data type: boolean
- Access type: Read-only
Protocol is a message-oriented protocol that can receive variable-length data packets or streamed data for all receive operations. This optional ability is useful when an application does not want the protocol to frame messages, and requires stream-oriented characteristics. If TRUE, the protocol is pseudo stream-oriented.
- Status
-
- Data type: string
- Access type: Read-only
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.
The values are:
- "OK"
- "Error"
- "Degraded"
- "Unknown"
- "Pred Fail"
- "Starting"
- "Stopping"
- "Service"
- "Stressed"
- "NonRecover"
- "No Contact"
- "Lost Comm"
- SupportsBroadcasting
-
- Data type: boolean
- Access type: Read-only
Protocol supports a mechanism for broadcasting messages across the network.
- SupportsConnectData
-
- Data type: boolean
- Access type: Read-only
Protocol allows data to be connected across the network.
- SupportsDisconnectData
-
- Data type: boolean
- Access type: Read-only
Protocol allows data to be disconnected across the network.
- SupportsEncryption
-
- Data type: boolean
- Access type: Read-only
Protocol supports data encryption.
- SupportsExpeditedData
-
- Data type: boolean
- Access type: Read-only
Protocol supports expedited data (also known as urgent data) across the network. Expedited data can bypass flow control and receive priority over normal data packets.
- SupportsFragmentation
-
- Data type: boolean
- Access type: Read-only
Protocol supports transmitting the data in fragments. Physical network maximum transfer unit (MTU) is hidden from applications. Each media type has a maximum frame size that cannot be exceeded. The link layer discovers the MTU and reports it to the protocols used.
- SupportsGracefulClosing
-
- Data type: boolean
- Access type: Read-only
Protocol supports two-phase close operations, also known as "graceful close operations". If not, the protocol supports only abortive close operations.
- SupportsGuaranteedBandwidth
-
- Data type: boolean
- Access type: Read-only
Protocol has a mechanism to establish and maintain a bandwidth.
- SupportsMulticasting
-
- Data type: boolean
- Access type: Read-only
Protocol supports multicasting.
- SupportsQualityofService
-
- Data type: boolean
- Access type: Read-only
Protocol is capable of Quality of Service (QoS) support by the underlying layered service provider or transport carrier. QoS is a collection of components that enable differentiation and preferential treatment for subsets of data transmitted over the network. QoS means subsets of data get higher priority or guaranteed service when traversing a network.
Remarks
The Win32_NetworkProtocol class is derived from CIM_LogicalElement.
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 [desktop apps only] |
|---|---|
|
Minimum supported server | Windows 2000 Server [desktop apps only] |
|
Namespace |
\root\CIMV2 |
|
MOF |
|
|
DLL |
|
See also
Send comments about this topic to Microsoft
Build date: 11/19/2012