GetNtmsUIOptionsW-Funktion (ntmsapi.h)

  • Artikel

[Wechseldatenträger-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 instance zurück, die von den Parametern lpObjectId und dwType bestimmt wird.

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

Syntax

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

Parameter

[in] hSession

Handle für die von der OpenNtmsSession-Funktion zurückgegebene Sitzung.

[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 von der Anwendung ausgelöste Bereitstellungsanforderung), eine Bibliothek (eine Tür öffnende Anforderung als Reaktion auf einen Auswurf) oder ein Computer (alle Benutzeroberfläche, die sich auf den Computer bezieht) sein.

Um den Computercontainer anzugeben, legen Sie den lpObjectId-Zeiger auf einen Puffer mit der Computerobjekt-GUID des Wechselspeicher-Managers fest. Legen Sie zum Angeben einer bestimmten Bibliothek auf einen Puffer mit der GUID der Bibliothek fest. Um eine Anwendung anzugeben, übergeben Sie einen NULL-Zeiger . Die Identität der Anwendung wird durch die in hSession verwendete Sitzung bestimmt. Beachten Sie, dass bei einer Anwendung mehrere Sitzungen gleichzeitig geöffnet werden können. 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-Nachrichten, die Informationen bereitstellen. Dazu gehören die Arbeitswarteschlangenelemente, die den Fortschritt anzeigen. Beispiel: Einbinden von Anforderungen.
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 enthalten. Dazu gehören Operatoranforderungen, die sich auf Fehlerbenachrichtigungen beziehen. Beispielsweise eine Anforderung zum sauber des Laufwerks.

[out] lpszDestination

Mehrzeichenfolgen, die die Namen der Computer zurückgibt, an die die Benutzeroberfläche umgeleitet wird. Dieser Parameter darf nicht NULL sein.

[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 ein oder mehrere RSM-Objekte wird verweigert.
ERROR_INSUFFICIENT_BUFFER
 Die von lpdwSize angegebene Puffergröße ist für die gefundenen Ziele zu klein. Die Funktion gibt die tatsächliche Größe in lpdwSize zurück.
ERROR_INVALID_HANDLE
 Das Sitzungshandle fehlt oder ist ungültig.
ERROR_INVALID_PARAMETER
 Der parameter lpdwSize oder lpszDestination ist NULL, oder lpObjectId ist kein gültiger Container, oder dwType ist keiner der drei gültigen Werte.
ERROR_NOT_ENOUGH_MEMORY
 Während der Verarbeitung ist ein Zuordnungsfehler aufgetreten.
ERROR_OBJECT_NOT_FOUND
 Die von lpObjectId angegebene GUID ist nicht die GUID eines Computers oder Bibliotheksobjekts in der Datenbank.
ERROR_SUCCESS
 Die Funktion war erfolgreich.

Hinweise

Ein Aufruf von GetNtmsUIOptions gibt eine Liste von Zielen für eine bestimmte instance zurück, die durch die Parameter lpObjectId und dwType bestimmt werden.

  NTMS_UITYPE_INFO NTMS_UITYPE_REQ NTMS_UITYPE_ERR
Anwendung Anzeigen des Arbeitselementstatus für Arbeitselemente, die von dieser Anwendung generiert wurden. Anzeige der Benutzeranforderungsoberfläche für Operatoranforderungen, die von Aktionen dieser Anwendung generiert werden. Nicht definiert. Anwendungen können diese Art von Fehlerereignis nicht verursachen.
Bibliothek Anzeigen des Arbeitselementstatus für Arbeitselemente, die dieser Bibliothek zugeordnet sind. Benutzeroberfläche für Anforderungen anzeigen, die dieser Bibliothek zugeordnet sind. Benutzeroberfläche für Fehler anzeigen, die dieser Bibliothek zugeordnet sind.
Computer Zeigen Sie die Informationsoberfläche in diesem instance der RSM an, die auf diesem Computer ausgeführt wird. Zeigen Sie eine Anforderungstyp-Benutzeroberfläche in diesem instance von RSM an. Anzeigen der Fehlertypbenutzeroberfläche in diesem instance von RSM.
 

Hinweis

Der ntmsapi.h-Header definiert GetNtmsUIOptions 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 nicht codierungsneutralem Code 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
Unterstützte Mindestversion (Client) Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2003 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile ntmsapi.h
Bibliothek Ntmsapi.lib
DLL Ntmsapi.dll

Weitere Informationen

Bibliothekssteuerungsfunktionen

SetNtmsUIOptions