IPortableDeviceCapabilities::GetCommandOptions-Methode (portabledeviceapi.h)

Die GetCommandOptions-Methode ruft alle unterstützten Optionen für den angegebenen Befehl auf dem Gerät ab.

Syntax

HRESULT GetCommandOptions(
  [in]  REFPROPERTYKEY        Command,
  [out] IPortableDeviceValues **ppOptions
);

Parameter

[in] Command

Ein REFPROPERTYKEY , der einen Befehl angibt, der nach unterstützten Optionen abgefragt werden soll. Eine Liste der Befehle, die von tragbaren Windows-Geräten definiert werden, finden Sie unter Befehle.

[out] ppOptions

Adresse einer Variablen, die einen Zeiger auf eine IPortableDeviceValues-Schnittstelle empfängt , die die unterstützten Optionen enthält. Wenn keine Optionen unterstützt werden, enthält diese keine Werte. Der Aufrufer muss diese Schnittstelle freigeben, wenn sie damit fertig ist. Weitere Informationen finden Sie in den Hinweisen.

Rückgabewert

Die Methode gibt ein HRESULT zurück. Mögliches Werte (aber nicht die Einzigen) sind die in der folgenden Tabelle.

Rückgabecode BESCHREIBUNG
S_OK
Die Methode wurde erfolgreich ausgeführt.

Hinweise

Diese Methode wird von Anwendungen aufgerufen, die einen Befehl direkt auf dem Treiber aufrufen möchten, indem IPortableDevice::SendCommand aufgerufen wird. Einige Befehle ermöglichen es dem Aufrufer, zusätzliche Optionen anzugeben. Einige Treiber unterstützen z. B. das rekursive untergeordnete Löschen beim Löschen eines Objekts mit dem Befehl WPD_COMMAND_OBJECT_MANAGEMENT_DELETE_OBJECTS.

Wenn eine Option ein einfacher boolescher Wert ist, ist der Schlüssel der abgerufenen IPortableDeviceValues-Schnittstelle der Name der Option, und der PROPVARIANT-Wert ist ein VT_BOOL Wert von True oder False. Wenn eine Option über mehrere Werte verfügt, ist der abgerufene PROPVARIANT-Wert ein Sammlungstyp, der die unterstützten Werte enthält.

Wenn diese Methode für den Befehl WPD_COMMAND_STORAGE_FORMAT aufgerufen wird und der ppOptions-Parameter auf WPD_OPTION_VALID_OBJECT_IDS festgelegt ist, gibt der Treiber eine IPortableDevicePropVariant-Auflistung vom Typ VT_LPWSTR zurück, die die Bezeichner für jedes Objekt auf dem Gerät angibt, das formatiert werden kann. (Wenn diese Option nicht vorhanden ist, ist der Formatbefehl für alle Objekte verfügbar.)

Anforderungen

Anforderung Wert
Zielplattform Windows
Kopfzeile portabledeviceapi.h
Bibliothek PortableDeviceGUIDs.lib

Weitere Informationen

IPortableDeviceCapabilities-Schnittstelle