SetIfEntry-Funktion (iphlpapi.h)

Artikel
08/24/2023

Die SetIfEntry-Funktion legt die administrative status einer Schnittstelle fest.

Syntax

IPHLPAPI_DLL_LINKAGE DWORD SetIfEntry(
  [in] PMIB_IFROW pIfRow
);

Parameter

[in] pIfRow

Ein Zeiger auf eine MIB_IFROW-Struktur . Das dwIndex-Element dieser Struktur gibt die Schnittstelle an, für die administrative status festgelegt werden soll. Das dwAdminStatus-Element gibt die neue administrative status an. Das dwAdminStatus-Element kann einer der folgenden Werte sein.

Wert	Bedeutung
MIB_IF_ADMIN_STATUS_UP	Die Schnittstelle ist administrativ aktiviert.
MIB_IF_ADMIN_STATUS_DOWN	Die Schnittstelle ist administrativ deaktiviert.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird der Rückgabewert NO_ERROR.

Wenn die Funktion fehlschlägt, ist der Rückgabewert einer der folgenden Fehlercodes.

Rückgabecode	Beschreibung
ERROR_ACCESS_DENIED	Der Zugriff wird verweigert. Dieser Fehler wird unter Windows Vista und höher unter folgenden Bedingungen zurückgegeben: Dem Benutzer fehlen die erforderlichen Administratorrechte auf dem lokalen Computer, oder die Anwendung wird nicht in einer erweiterten Shell als integrierter Administrator (RunAs-Administrator) ausgeführt.
ERROR_FILE_NOT_FOUND	Die angegebene Datei wurde nicht gefunden. Dieser Fehler wird unter Windows Vista und höher zurückgegeben, wenn die netzwerkschnittstelle, die vom dwIndex-Member der MIB_IFROW Struktur angegeben wurde, auf die der pIfRow-Parameter verweist, nicht gefunden werden konnte.
ERROR_INVALID_PARAMETER	Es wurde ein ungültiger Parameter an die Funktion übergeben. Dieser Fehler wird zurückgegeben, wenn ein NULL-Zeiger im pIfRow-Parameter übergeben wird oder das dwIndex-Element der MIB_IFROW , auf die der pIfRow-Parameter verweist, nicht angegeben wurde. Dieser Fehler wird auch unter Windows Server 2003 und früher zurückgegeben, wenn die netzwerkschnittstelle, die vom dwIndex-Member der MIB_IFROW Struktur angegeben wurde, auf die der pIfRow-Parameter verweist, nicht gefunden wurde.
ERROR_NOT_SUPPORTED	Die Anforderung wird nicht unterstützt. Dieser Fehler wird unter Windows Server 2003 und früher zurückgegeben, wenn auf dem lokalen Computer kein TCP/IP-Stapel konfiguriert ist.
Andere	Verwenden Sie FormatMessage , um die Nachrichtenzeichenfolge für den zurückgegebenen Fehler abzurufen.

Hinweise

Die SetIfEntry-Funktion wird verwendet, um die administrative status einer Schnittstelle auf einem lokalen Computer festzulegen.

Das dwIndex-Element in der MIB_IFROW-Struktur , auf die der pIfRow-Parameter verweist, muss für den Schnittstellenindex initialisiert werden.

Die SetIfEntry-Funktion schlägt fehl, wenn das dwIndex-Element des MIB_IFROW , auf das vom pIfRow-Parameter verwiesen wird, nicht mit einer vorhandenen Schnittstelle auf dem lokalen Computer übereinstimmt.

Unter Windows Vista und höher kann die SetIfEntry-Funktion nur von einem Benutzer aufgerufen werden, der sich als Mitglied der Gruppe Administratoren angemeldet hat. Wenn SetIfEntry von einem Benutzer aufgerufen wird, der kein Mitglied der Gruppe Administratoren ist, schlägt der Funktionsaufruf fehl, und ERROR_ACCESS_DENIED wird zurückgegeben.

Die SetIfEntry-Funktion kann auch aufgrund der Benutzerkontensteuerung (User Account Control, UAC) unter Windows Vista und höher fehlschlagen. Wenn eine Anwendung, die diese Funktion enthält, von einem Benutzer ausgeführt wird, der nicht als mitglied der Gruppe Administratoren als der integrierte Administrator angemeldet ist, schlägt dieser Aufruf fehl, es sei denn, die Anwendung wurde in der Manifestdatei mit einem requestedExecutionLevel-Wert gekennzeichnet, der auf requireAdministrator festgelegt ist. Wenn der Anwendung diese Manifestdatei fehlt, muss ein Benutzer, der sich als anderes Mitglied der Administratorgruppe als der integrierte Administrator angemeldet hat, die Anwendung dann in einer erweiterten Shell als integrierter Administrator (RunAs-Administrator) ausführen, damit diese Funktion erfolgreich ist.

Hinweis Unter Windows NT 4.0 und Windows 2000 und höher führt diese Funktion einen privilegierten Vorgang aus. Damit diese Funktion erfolgreich ausgeführt werden kann, muss der Aufrufer als Mitglied der Gruppe Administratoren oder der Gruppe NetworkConfigurationOperators angemeldet sein.

Anforderungen


Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	iphlpapi.h
Bibliothek	Iphlpapi.lib
DLL	Iphlpapi.dll