EnumProtocolsA-Funktion (nspapi.h)
Die EnumProtocols-Funktion ruft Informationen zu einer bestimmten Gruppe von Netzwerkprotokollen ab, die auf einem lokalen Host aktiv sind.
Syntax
INT EnumProtocolsA(
[in, optional] LPINT lpiProtocols,
[out] LPVOID lpProtocolBuffer,
[in, out] LPDWORD lpdwBufferLength
);
Parameter
[in, optional] lpiProtocols
Ein Zeiger auf ein NULL--terminated Array von Protokollbezeichnern. Die "EnumProtocols" Funktion ruft Informationen zu den von diesem Array angegebenen Protokollen ab.
Wenn lpiProtocolsNULL-ist, ruft die Funktion Informationen zu allen verfügbaren Protokollen ab.
Die folgenden Protokollbezeichnerwerte werden definiert.
[out] lpProtocolBuffer
Ein Zeiger auf einen Puffer, den die Funktion mit einem Array von PROTOCOL_INFO Datenstrukturen ausfüllt.
[in, out] lpdwBufferLength
Ein Zeiger auf eine Variable, die bei eingabe die Größe des Puffers in Byte angibt, auf den lpProtocolBufferverweist.
Bei der Ausgabe legt die Funktion diese Variable auf die minimale Puffergröße fest, die zum Abrufen aller angeforderten Informationen erforderlich ist. Damit die Funktion erfolgreich ausgeführt werden kann, muss der Puffer mindestens diese Größe aufweisen.
Rückgabewert
Wenn die Funktion erfolgreich ist, ist der Rückgabewert die Anzahl der PROTOCOL_INFO Datenstrukturen, die in den Puffer geschrieben wurden, auf lpProtocolBufferverweist.
Wenn die Funktion fehlschlägt, ist der Rückgabewert SOCKET_ERROR(–1). Rufen Sie zum Abrufen erweiterter Fehlerinformationen GetLastErrorauf, der den folgenden erweiterten Fehlercode zurückgibt.
| Fehlercode | Bedeutung |
|---|---|
|
Der Puffer, auf den lpProtocolBuffer verweist, war zu klein, um alle relevanten PROTOCOL_INFO Strukturen zu empfangen. Rufen Sie die Funktion mit einem Puffer mindestens so groß auf, wie der in *lpdwBufferLengthzurückgegebene Wert. |
Bemerkungen
Im folgenden Beispielcode ruft die EnumProtocols Funktion Informationen zu allen Protokollen ab, die in einem System verfügbar sind. Der Code untersucht dann jedes der Protokolle ausführlicher.
#define WIN32_LEAN_AND_MEAN
#include <windows.h>
#include <winsock2.h>
#include <ws2tcpip.h>
#include <Nspapi.h>
#include <stdlib.h>
#include <stdio.h>
// Need to link with Ws2_32.lib and Mswsock.lib
#pragma comment (lib, "Ws2_32.lib")
#pragma comment (lib, "Mswsock.lib")
int FindProtocol(BOOL Reliable,
BOOL MessageOriented, BOOL StreamOriented,
BOOL Connectionless, DWORD *ProtocolUsed);
int __cdecl main(int argc, char **argv)
{
WSADATA wsaData;
int ProtocolError = SOCKET_ERROR;
int iResult;
BOOLEAN bReliable = FALSE;
BOOLEAN bMessageOriented = FALSE;
BOOLEAN bStreamOriented = TRUE;
BOOLEAN bConnectionless = FALSE;
DWORD *pProtocols = NULL;
// Validate the parameters
if (argc != 2) {
printf("usage: %s servicename\n", argv[0]);
return 1;
}
// Initialize Winsock
iResult = WSAStartup(MAKEWORD(2,2), &wsaData);
if (iResult != 0) {
printf("WSAStartup failed with error: %d\n", iResult);
return 1;
}
ProtocolError = FindProtocol( bReliable, bMessageOriented,
bStreamOriented, bConnectionless, pProtocols);
if (ProtocolError == SOCKET_ERROR) {
printf("Unable to find a protocol to support the parameters requested\n");
return 1;
}
// Connect to the servicename ...
return 0;
}
#define MAX_PROTOCOLS 1024
int FindProtocol (
BOOL Reliable,
BOOL MessageOriented,
BOOL StreamOriented,
BOOL Connectionless,
DWORD *ProtocolUsed
)
{
// local variables
INT protocols[MAX_PROTOCOLS+1];
BYTE buffer[2048];
DWORD bytesRequired;
INT err;
PPROTOCOL_INFO protocolInfo;
INT protocolCount;
INT i;
DWORD protocolIndex;
// PCSADDR_INFO csaddrInfo;
// INT addressCount;
// SOCKET s;
// First look up the protocols installed on this computer.
//
bytesRequired = sizeof(buffer);
err = EnumProtocols( NULL, buffer, &bytesRequired );
if ( err <= 0 )
return SOCKET_ERROR;
// Walk through the available protocols and pick out the ones which
// support the desired characteristics.
//
protocolCount = err;
protocolInfo = (PPROTOCOL_INFO)buffer;
for ( i = 0, protocolIndex = 0;
i < protocolCount && protocolIndex < MAX_PROTOCOLS;
i++, protocolInfo++ ) {
// If connection-oriented support is requested, then check if
// supported by this protocol. We assume here that connection-
// oriented support implies fully reliable service.
//
if ( Reliable ) {
// Check to see if the protocol is reliable. It must
// guarantee both delivery of all data and the order in
// which the data arrives.
//
if ( (protocolInfo->dwServiceFlags &
XP_GUARANTEED_DELIVERY) == 0
||
(protocolInfo->dwServiceFlags &
XP_GUARANTEED_ORDER) == 0 ) {
continue;
}
// Check to see that the protocol matches the stream/message
// characteristics requested.
//
if ( StreamOriented &&
(protocolInfo->dwServiceFlags & XP_MESSAGE_ORIENTED)
!= 0 &&
(protocolInfo->dwServiceFlags & XP_PSEUDO_STREAM)
== 0 ) {
continue;
}
if ( MessageOriented &&
(protocolInfo->dwServiceFlags & XP_MESSAGE_ORIENTED)
== 0 ) {
continue;
}
}
else if ( Connectionless ) {
// Make sure that this is a connectionless protocol.
//
if ( (protocolInfo->dwServiceFlags & XP_CONNECTIONLESS)
!= 0 )
continue;
}
// This protocol fits all the criteria. Add it to the list of
// protocols in which we're interested.
//
protocols[protocolIndex++] = protocolInfo->iProtocol;
}
*ProtocolUsed = (INT) protocolIndex;
return 0;
}
Anmerkung
Der nspapi.h-Header definiert EnumProtocols als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.
Anforderungen
| Anforderung | Wert |
|---|---|
| mindestens unterstützte Client- | Windows 2000 Professional [nur Desktop-Apps] |
| mindestens unterstützte Server- | Windows 2000 Server [nur Desktop-Apps] |
| Zielplattform- | Fenster |
| Header- | nspapi.h |
| Library | Mswsock.lib |
| DLL- | Mswsock.dll |