Freigeben über


CreateNtmsMediaA-Funktion (ntmsapi.h)

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

Die CreateNtmsMedia--Funktion erstellt eine PMID und eine Seite (oder Seiten) für ein neues Element von Offlinemedien. Die Medien werden im medienpool platziert, der für lpPhysicalMediaangegeben ist.

Syntax

DWORD CreateNtmsMediaA(
  [in] HANDLE                    hSession,
  [in] LPNTMS_OBJECTINFORMATIONA lpMedia,
  [in] LPNTMS_OBJECTINFORMATIONA lpList,
  [in] DWORD                     dwOptions
);

Parameter

[in] hSession

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

[in] lpMedia

Zeigen Sie auf eine NTMS_OBJECTINFORMATION Struktur, die Informationen zum zu erstellenden Medium enthält. Eine Beschreibung der anwendbaren Mitglieder finden Sie in den Hinweisen.

[in] lpList

Zeigen Sie auf eine NTMS_OBJECTINFORMATION Struktur, die ein Array von Seiten angibt, die dem Medium zugeordnet sind. Eine Beschreibung der anwendbaren Mitglieder finden Sie in den Hinweisen.

[in] dwOptions

Optionen. Dieser Parameter kann einer der folgenden Werte sein:

Wert Bedeutung
0
Standardwert. Ermöglicht die Erstellung eines doppelten Mediums mit einer doppelten OMID.
NTMS_ERROR_ON_DUPLICATE
Gibt einen Fehler zurück und erstellt das Medium nicht, wenn ein Medium mit der angegebenen OMID bereits im System vorhanden ist.

Rückgabewert

Diese Funktion gibt einen der folgenden Werte zurück.

Wert Bedeutung
ERROR_ACCESS_DENIED
NTMS_MODIFY_ACCESS auf den Computer oder den Medienpool des Mediums wird verweigert. Andere Sicherheitsfehler sind möglich, weisen jedoch auf einen Sicherheitssubsystemfehler hin.

Windows XP: NTMS_CONTROL_ACCESS an den Medienpool oder NTMS_MODIFY_ACCESS für die Offlinebibliothek wird verweigert. Andere Sicherheitsfehler sind möglich, weisen jedoch auf einen Sicherheitssubsystemfehler hin.

ERROR_DATABASE_FAILURE
Auf die Datenbank kann nicht zugegriffen oder beschädigt werden.
ERROR_DATABASE_FULL
Die Datenbank ist voll.
ERROR_DUPLICATE_OMID
Die Option NTMS_ERROR_ON_DUPLICATE wurde bereitgestellt, und es ist bereits ein Medium mit dieser OMID vorhanden.
ERROR_INVALID_HANDLE
Der Sitzungshandle fehlt oder ist ungültig.
ERROR_INVALID_MEDIA
Für ein Medium mit diesem Barcode ist bereits ein Eintrag vorhanden.
ERROR_INVALID_MEDIA_POOL
Der angegebene Medienpool ist entweder nicht vorhanden oder kein gültiger Import- oder Anwendungspool.
ERROR_INVALID_PARAMETER
Ein Parameter fehlt, oder die Objektinformationsgröße oder der Objekttyp ist ungültig.
ERROR_MEDIA_INCOMPATIBLE
Die Anzahl der angegebenen Seiten stimmt nicht mit der Anzahl der Seiten überein, die dem Medientyp des Medienpools zugeordnet sind.
ERROR_NOT_ENOUGH_MEMORY
Fehler bei der Speicherzuweisung während der Verarbeitung.
ERROR_SUCCESS
Die Funktion wurde erfolgreich ausgeführt.

Bemerkungen

Der parameter lpMedia muss auf eine NTMS_OBJECTINFORMATION Struktur verweisen, deren dwType-parameter NTMS_PHYSICAL_MEDIA ist. Es folgt eine Liste der Elemente und Beschreibungen für die NTMS_OBJECTINFORMATION Struktur.

Mitglied Beschreibung
dwSize- [in] CreateNtmsMedia überprüft, ob diese Größe der Länge einer NTMS_OBJECTINFORMATION Struktur entspricht, die eine NTMS_PMIDINFORMATION Struktur enthält. Sie gibt ERROR_INVALID_PARAMETER zurück, wenn die Größe falsch ist.
dwType- [in] CreateNtmsMedia überprüft, ob der wert NTMS_PHYSICAL_MEDIA angegeben wurde. Sie gibt ERROR_INVALID_PARAMETER zurück, wenn der angegebene Typ falsch ist.
Erstellt [out] Gibt an, wie lange das physische Medienobjekt in die NTMS-Datenbank eingegeben wurde.
Geänderte [out] Gibt an, wie lange das physische Medienobjekt in die NTMS-Datenbank eingegeben wurde.
ObjectGuid- [in/out] Eindeutiger Bezeichner für das physische Medienobjekt (PMID). Wenn ein Wert ohneNULL angegeben wird, wird der Wert als GUID des physischen Mediums verwendet, andernfalls wird eine GUID generiert.
Aktivierte [in] Gibt an, ob das physische Medium aktiviert werden soll.
dwOperationalState- [out] Muss NTMS_READY sein.
szName [in/out] CreateNtmsMedia- ermöglicht es einer Anwendung, den Namen eines neuen physischen Mediums anzugeben. Dadurch kann die Anwendung weiterhin den Namen eines Mediums verwenden, nachdem sie von einem RSM-Computer auf einen anderen verschoben wurde. Die STANDARDMÄßIGe Benennungsauswahl für RSM lautet: für einseitig: Barcode, dann Beschriftungsinformationenwert oder Sequenznummer;. für mehrseitigen Medien-Barcode und dann Sequenznummer.

Beachten Sie, dass der Name, der in der RSM-Benutzeroberfläche für eine Partition angezeigt wird, dieser Name ist (der Name, der dem physischen Medienobjekt zugewiesen ist).

szDescription- [in] Ein optionaler Parameter, der mit CreateNtmsMediafestgelegt werden kann. Geben Sie die leere Zeichenfolge ("\0") an, um zu vermeiden, dass ein Wert für die Beschreibung übergeben wird.
 

Es folgt eine Liste der Member und Beschreibungen für die NTMS_PMIDINFORMATION-Struktur.

Mitglied Beschreibung
CurrentLibrary- [in] Muss entweder die NULL_GUID oder die GUID der Offlinebibliothek sein.
MediaPool- [in] Muss die GUID eines gültigen Import- oder Anwendungspools sein.

CreateNtmsMedia überprüft, ob dies die GUID eines gültigen Import- oder Anwendungspools ist. Außerdem wird überprüft, ob die Anzahl der bereitgestellten Partitionen für den Medientyp korrekt ist, der diesem Medienpool zugeordnet ist.

[out] Muss die NULL_GUID sein.
LocationType- [out] Muss NTMS_STORAGESLOT sein.
HomeSlot- [out] Muss die NULL_GUID sein.
MediaType- [out] CreateNtmsMedia legt den Medientyp auf den Medientyp fest, der dem bereitgestellten Medienpool zugeordnet ist.
szBarCode- [in/out] Der Barcode wird von allen Endzeichen entfernt. CreateNtmsMedia führt keine zusätzlichen Versuche zur Überprüfung der Gültigkeit des Barcodes durch.
BarCodeState- [out] Die BarCodeState- wird auf NTMS_BARCODESTATE_UNREADABLE festgelegt, wenn der für szBarCode übergebene Wert eine leere Zeichenfolge ist, andernfalls wird er auf NTMS_BARCODESTATE_OK festgelegt.
szSequenceNumber [out] CreateNtmsMedia die neu erstellte mittlere Sequenznummer zuweist, die in diesem Element zurückgegeben wird.
MediaState- [out] CreateNtmsMedia- legt "MediaState" auf NTMS_MEDIASTATE_IDLE fest.
dwNumberOfPartitions- [in] Definiert die Anzahl der NTMS_OBJECTINFORMATION Strukturen, die Seiten für dieses Medium darstellen. CreateNtmsMedia überprüft, ob die angegebene Anzahl von Seiten mit der Anzahl der Seiten übereinstimmt, die vom Medienpool impliziert werden, dem sie zugewiesen werden soll. Wenn sie nicht übereinstimmen, wird ERROR_MEDIA_INCOMPATIBLE zurückgegeben.
dwMediaTypeCode- [in] SCSI-Medientypcode.

Dieses Mitglied wird nicht von RSM verwendet, kann aber von Anwendungen verwendet werden, die in RSM geschrieben wurden, um zusätzliche Informationen zu den Medien zu erhalten. Eine Beschreibung, auf die dieses Mitglied festgelegt werden soll, finden Sie in der SCSI-Spezifikation des Hardwareherstellers für mögliche Einstellungen.

RSM aktualisiert dieses Element, wenn es das neu importierte Medium zum ersten Mal einrichtet.

dwDensityCode- [in] SCSI-Dichtecode.

Dieses Mitglied wird nicht von RSM verwendet, kann aber von Anwendungen verwendet werden, die in RSM geschrieben wurden, um zusätzliche Informationen zu den Medien zu erhalten. Eine Beschreibung, auf die dieses Mitglied festgelegt werden soll, finden Sie in der SCSI-Spezifikation des Hardwareherstellers für mögliche Einstellungen.

RSM aktualisiert dieses Mitglied, wenn es das neu importierte Medium zum ersten Mal einrichtet.

 

Der parameter lpList muss auf eine NTMS_OBJECTINFORMATION Struktur verweisen, deren dwType- mit den folgenden Informationen NTMS_PARTITION ist.

Mitglied Beschreibung
dwSize- [in] CreateNtmsMedia überprüft, ob die angegebene Größe mit der erwarteten Länge einer NTMS_OBJECTINFORMATION Struktur übereinstimmt, die eine NTMS_PARTITIONINFORMATION Struktur enthält. Sie gibt ERROR_INVALID_PARAMETER zurück, wenn die Größe falsch ist.
dwType- [in] CreateNtmsMedia überprüft, ob der wert NTMS_PARTITION bereitgestellt wurde. Sie gibt ERROR_INVALID_PARAMETER zurück, wenn der angegebene Typ falsch ist.
Erstellt [out] Gibt die Uhrzeit an, zu der das Partitionsobjekt in die RSM-Datenbank eingegeben wurde.
Geänderte [out] Gibt die Uhrzeit an, zu der das Partitionsobjekt in die RSM-Datenbank eingegeben wurde.
ObjectGuid- [in/out] Eindeutiger Bezeichner für die Seite. Wenn ein Wert ohneNULL angegeben wird, wird der Wert als GUID der Seite verwendet. andernfalls wird eine GUID generiert.
Aktivierte [in] Bestimmt, ob die Seite aktiviert werden soll.
dwOperationalState- [out] Muss NTMS_READY sein.
szName [in] Name einer neuen Seite.
szDescription- [in] Optionaler Parameter, der mit CreateNtmsMediafestgelegt werden kann. Geben Sie die leere Zeichenfolge ("\0") an, um zu vermeiden, dass ein Wert für die Beschreibung übergeben wird.
PhysicalMedia [out] GUID des neu erstellten Seitenobjekts.
LogicalMedia- [in/out] Optionaler Eingabeparameter sowie ein Ausgabeparameter. Wenn die GUID bereitgestellt wird, versucht CreateNtmsMedia, ein neues logisches Medienobjekt mit der vordefinierten GUID zu erstellen. Wenn die GUID nicht eindeutig ist, gibt CreateNtmsMedia einen Fehler zurück.
State [in] Ein beliebiger gültiger Seitenzustand.
side [out] CreateNtmsMedia legt die Seitenzahl auf den Offset im Partitionsarray fest.
dwOmidLabelIdLength [in] Muss ein positiver Wert sein.

CreateNtmsMedia verwendet die dwOmidLabelIdLength-, um die Anzahl der signifikanten Bytes im OmidLabelId-Member zu bestimmen. Wenn der Wert nicht korrekt ist, ist die aufgezeichnete OmidLabelId- falsch.

OmidLabelId- [in] Muss eine gültige Medienbezeichnung sein, die von einer installierten MLL erkannt werden kann.
szOmidLabelType [in] Darf keine leere Zeichenfolge sein.
szOmidLabelInfo [in] Möglicherweise ist die leere Zeichenfolge.
dwMountCount- [in] Jeder Wert wird akzeptiert.
dwAllocateCount [in] Jeder Wert wird akzeptiert.
Kapazität [in] SCSI-Kapazitätscode.

Dieses Mitglied wird nicht von RSM verwendet, kann aber von Anwendungen verwendet werden, die in RSM geschrieben wurden, um zusätzliche Informationen zu den Medien zu erhalten. Eine Beschreibung, auf die dieses Mitglied festgelegt werden soll, finden Sie in der SCSI-Spezifikation des Hardwareherstellers für mögliche Einstellungen.

RSM aktualisiert dieses Element, wenn es das neu importierte Medium zum ersten Mal einrichtet.

 

Anmerkung

Der ntmsapi.h-Header definiert CreateNtmsMedia 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

Media Services-Funktionen