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

[Dynamic, Provider("CIMWin32"), UUID("{8502C4D8-5FBB-11D2-AAC1-006008C78BC7}"), AMENDMENT]
class Win32_NetworkProtocol : CIM_LogicalElement
{
  string   Caption;
  string   Description;
  datetime InstallDate;
  string   Status;
  boolean  ConnectionlessService;
  boolean  GuaranteesDelivery;
  boolean  GuaranteesSequencing;
  uint32   MaximumAddressSize;
  uint32   MaximumMessageSize;
  boolean  MessageOriented;
  uint32   MinimumAddressSize;
  string   Name;
  boolean  PseudoStreamOriented;
  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

Properties

The Win32_NetworkProtocol class has these properties.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64), DisplayName ("Caption")

A short textual description of the object.

This property is inherited from CIM_ManagedSystemElement.

ConnectionlessService

Data type: boolean

Access type: Read-only

Qualifiers: MappingStrings ("Win32_API|Windows Sockets Structures|PROTOCOL_INFO|dwServiceFlags|XP1_CONNECTIONLESS")

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

Qualifiers: DisplayName ("Description")

A textual description of the object.

This property is inherited from CIM_ManagedSystemElement.

GuaranteesDelivery

Data type: boolean

Access type: Read-only

Qualifiers: MappingStrings ("Win32_API|Windows Sockets Structures|PROTOCOL_INFO|dwServiceFlags|XP_GUARANTEED_DELIVERY")

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

Qualifiers: MappingStrings ("Win32_API|Windows Sockets Structures|PROTOCOL_INFO|dwServiceFlags|XP_GUARANTEED_ORDER")

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

Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5"), DisplayName ("Install Date")

Indicates when the object was installed. Lack of a value does not indicate that the object is not installed.

This property is inherited from CIM_ManagedSystemElement.

MaximumAddressSize

Data type: uint32

Access type: Read-only

Qualifiers: MappingStrings ("Win32_API|Windows Sockets Structures|PROTOCOL_INFO|iMaxSockAddr"), 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: MappingStrings ("Win32_API|Windows Sockets Structures|PROTOCOL_INFO|dwMessageSize"), 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

Qualifiers: MappingStrings ("Win32_API|Windows Sockets Structures|PROTOCOL_INFO|dwServiceFlags|XP_MESSAGE_ORIENTED")

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: MappingStrings ("Win32_API|Windows Sockets Structures|PROTOCOL_INFO|iMinSockAddr "), units ("characters")

Minimum length of a socket address supported by the protocol.

Name

Data type: string

Access type: Read-only

Qualifiers: key, Override ("Name"), MappingStrings ("Win32_API|Windows Sockets Structures|PROTOCOL_INFO|lpProtocol")

Name for the protocol.

Example: "TCP/IP"

PseudoStreamOriented

Data type: boolean

Access type: Read-only

Qualifiers: MappingStrings ("Win32_API|Windows Sockets Structures|PROTOCOL_INFO|dwServiceFlags|XP_PSEUDO_STREAM")

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

Qualifiers: MaxLen (10), DisplayName ("Status")

String that indicates the current status of the object. Operational and non-operational status can be defined. Operational status can include "OK", "Degraded", and "Pred Fail". "Pred Fail" indicates that an element is functioning properly, but is predicting a failure (for example, a SMART-enabled hard disk drive).

Non-operational status can include "Error", "Starting", "Stopping", and "Service". "Service" can apply during disk mirror-resilvering, reloading a user permissions list, or other administrative work. Not all such work is online, but the managed element is neither "OK" nor in one of the other states.

This property is inherited from CIM_ManagedSystemElement.

Values include the following:

OK ("OK")

Error ("Error")

Degraded ("Degraded")

Unknown ("Unknown")

Pred Fail ("Pred Fail")

Starting ("Starting")

Stopping ("Stopping")

Service ("Service")

Stressed ("Stressed")

NonRecover ("NonRecover")

No Contact ("No Contact")

Lost Comm ("Lost Comm")

Remarks

The Win32_NetworkProtocol class is derived from CIM_LogicalElement.

Examples

The following VBScript code sample demonstrates how to retrieve a list of running services from instances of Win32_NetworkProtocol.

Set ProtocolSet = GetObject("winmgmts:").ExecQuery("select * from Win32_NetworkProtocol")

for each Protocol in ProtocolSet
 WScript.Echo Protocol.Name
next

The following Perl code sample demonstrates how to retrieve a list of running services from instances of Win32_NetworkProtocol.

use strict;
use Win32::OLE;

my ( $ProtocolSet, $Protocol );

eval { $ProtocolSet = Win32::OLE->GetObject("winmgmts:{impersonationLevel=impersonate}!\\\\.\\root\\cimv2")->
 ExecQuery("SELECT * FROM Win32_NetworkProtocol"); };
unless($@)
{
 print "\n";
 foreach $Protocol (in $ProtocolSet) 
 {
  print $Protocol->{Name}, "\n";
 }
}
else
{
 print STDERR Win32::OLE->LastError, "\n";
}

Requirements

See also

CIM_LogicalElement

Operating System Classes