GetNtmsUIOptionsA-Funktion (ntmsapi.h)

Artikel
11/20/2024

[Wechselmedien-Manager ist ab Windows 7 und Windows Server 2008 R2 nicht mehr verfügbar.]

Die GetNtmsUIOptions Funktion ruft die Liste der Computernamen ab, an die der angegebene Typ der Benutzeroberfläche für das angegebene Objekt weitergeleitet wird. Ein Aufruf von GetNtmsUIOptions gibt die Liste der Ziele für die Instanz zurück, die durch die parameter lpObjectId und dwType bestimmt wird.

Wenn in der Liste für die angegebene Instanz keine Ziele vorhanden sind, gibt die Funktion ERROR_SUCCESS zusammen mit einer Listenlänge von Null zurück.

Syntax

DWORD GetNtmsUIOptionsA(
  [in]      HANDLE            hSession,
  [in]      const LPNTMS_GUID lpObjectId,
  [in]      DWORD             dwType,
  [out]     LPSTR             lpszDestination,
  [in, out] LPDWORD           lpdwBufSize
);

Parameter

[in] hSession

Behandeln Sie die sitzung, die von der OpenNtmsSession--Funktion zurückgegeben wird.

[in] lpObjectId

Eindeutiger Bezeichner des Objekts, dessen Benutzeroberfläche umgeleitet wird. Das Objekt muss ein Container sein, der eine Quelle für Ereignisse sein kann. Das Objekt kann entweder eine Anwendung (eine bereitstellungsanforderung sein, die von der Anwendung ausgelöst wird), eine Bibliothek (eine Tür geöffnete Anforderung als Reaktion auf einen Auswurf) oder ein Computer (alle UI, die sich auf den Computer beziehen).

Um den Computercontainer anzugeben, legen Sie den lpObjectId Zeiger auf einen Puffer mit der Computerobjekt-GUID des Wechselmedien-Managers fest. Um eine bestimmte Bibliothek anzugeben, legen Sie sie so fest, dass sie auf einen Puffer mit der GUID der Bibliothek verweist. Übergeben Sie zum Angeben einer Anwendung einen NULL- Zeiger. Die Identität der Anwendung wird von der sitzung bestimmt, die in hSessionverwendet wird. Beachten Sie, dass eine Anwendung mehrere Sitzungen gleichzeitig geöffnet haben kann. In diesem Fall gilt der Wertsatz nur für die hSession Sitzung.

[in] dwType

Dieser Parameter kann einen der folgenden Werte aufweisen.

Wert	Bedeutung
NTMS_UITYPE_INFO	UI-Meldungen, die Informationen bereitstellen. Dazu gehören die Arbeitswarteschlangenelemente, die den Fortschritt angeben. Beispiel: Bereitstellungsanforderungen.
NTMS_UITYPE_REQ	Ui-Nachrichten, die Anforderungen sind. Dazu gehören die Operatoranforderungen, die Medien verarbeiten. Beispielsweise eine Anforderung zum Einfügen neuer Medien.
NTMS_UITYPE_ERR	UI-Meldungen, die Fehlerinformationen liefern. Dazu gehören Operatoranforderungen, die sich auf fehlerbenachrichtigungen beziehen. Beispielsweise eine Anforderung zum Bereinigen des Laufwerks.

[out] lpszDestination

Mehrere Zeichenfolgen, die die Namen der Computer zurückgeben, an die die Benutzeroberfläche umgeleitet wird. Dieser Parameter kann nicht NULL-werden.

[in, out] lpdwBufSize

Größe der Zielzeichenfolge in TCHARs.

Rückgabewert

Diese Funktion gibt einen der folgenden Werte zurück.

Wert	Bedeutung
ERROR_ACCESS_DENIED	Der Zugriff auf mindestens ein RSM-Objekt wird verweigert.
ERROR_INSUFFICIENT_BUFFER	Die durch lpdwSize- angegebene Puffergröße ist zu klein für die gefundenen Ziele. Die Funktion gibt die tatsächliche Größe in lpdwSizezurück.
ERROR_INVALID_HANDLE	Der Sitzungshandle fehlt oder ist ungültig.
ERROR_INVALID_PARAMETER	Der lpdwSize oder lpszDestination Parameter ist NULL-oder lpObjectId- kein gültiger Container, oder dwType- ist keine der drei gültigen Werte.
ERROR_NOT_ENOUGH_MEMORY	Während der Verarbeitung ist ein Zuordnungsfehler aufgetreten.
ERROR_OBJECT_NOT_FOUND	Die durch lpObjectId angegebene GUID ist nicht die GUID eines Computers oder Bibliotheksobjekts in der Datenbank.
ERROR_SUCCESS	Die Funktion war erfolgreich.

Bemerkungen

Ein Aufruf von GetNtmsUIOptions gibt eine Liste der Ziele für eine bestimmte Instanz zurück, die durch die parameter lpObjectId und dwType bestimmt wird.

	NTMS_UITYPE_INFO	NTMS_UITYPE_REQ	NTMS_UITYPE_ERR
Anwendung	Anzeigen der Arbeitsaufgabenstatus-UI für Arbeitsaufgaben, die von dieser Anwendung generiert werden.	Anzeigeoperatoranforderungs-UI für Operatoranforderungen, die von Aktionen generiert werden, die von dieser Anwendung ausgeführt werden.	Undefiniert. Anwendungen können diese Art von Fehlerereignis nicht verursachen.
Bibliothek	Anzeigen der Arbeitsaufgabenstatus-UI für Arbeitsaufgaben, die dieser Bibliothek zugeordnet sind.	Zeigen Sie die Benutzeroberfläche für Anforderungen an, die dieser Bibliothek zugeordnet sind.	Zeigen Sie die Benutzeroberfläche für Fehler an, die dieser Bibliothek zugeordnet sind.
Computer	Zeigen Sie die Informations-UI in dieser Instanz von RSM an, die auf diesem Computer ausgeführt wird.	Anzeigen einer Anforderungstyp-UI in dieser Instanz von RSM.	Anzeigen der Fehlertyp-UI in dieser Instanz von RSM.

Anmerkung

Der ntmsapi.h-Header definiert GetNtmsUIOptions als Alias, der automatisch die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante 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 XP [nur Desktop-Apps]
mindestens unterstützte Server-	Windows Server 2003 [Nur Desktop-Apps]
Zielplattform-	Fenster
Header-	ntmsapi.h
Library	Ntmsapi.lib
DLL-	Ntmsapi.dll

Siehe auch

Bibliothekssteuerungsfunktionen

SetNtmsUIOptions-

Freigeben über