Método IPortableDeviceCapabilities::GetCommandOptions (portabledeviceapi.h)

El método GetCommandOptions recupera todas las opciones admitidas para el comando especificado en el dispositivo.

Sintaxis

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

Parámetros

[in] Command

REFPROPERTYKEY que especifica un comando para consultar las opciones admitidas. Para obtener una lista de los comandos definidos por dispositivos portátiles de Windows, vea Comandos.

[out] ppOptions

Dirección de una variable que recibe un puntero a una interfaz IPortableDeviceValues que contiene las opciones admitidas. Si no se admite ninguna opción, no contendrá ningún valor. El autor de la llamada debe liberar esta interfaz cuando haya terminado con ella. Para obtener más información, vea la sección Comentarios.

Valor devuelto

El método devuelve un valor HRESULT. Entre los valores posibles se incluyen los que se indican en la tabla siguiente, entre otros.

Código devuelto	Descripción
S_OK	El método se ha llevado a cabo de forma correcta.

Comentarios

Las aplicaciones que quieren llamar a un comando directamente en el controlador llaman a este método mediante una llamada a IPortableDevice::SendCommand. Algunos comandos permiten al autor de la llamada especificar opciones adicionales. Por ejemplo, algunos controladores admiten la eliminación secundaria recursiva al eliminar un objeto mediante el comando WPD_COMMAND_OBJECT_MANAGEMENT_DELETE_OBJECTS.

Si una opción es un valor booleano simple, la clave de la interfaz IPortableDeviceValues recuperada será el nombre de la opción y el valor PROPVARIANT será un valor VT_BOOL de True o False. Si una opción tiene varios valores, el valor PROPVARIANT recuperado será un tipo de colección que contiene los valores admitidos.

Si se llama a este método para el comando WPD_COMMAND_STORAGE_FORMAT y el parámetro ppOptions se establece en WPD_OPTION_VALID_OBJECT_IDS, el controlador devolverá una colección IPortableDevicePropVariant de tipo VT_LPWSTR que especifica los identificadores de cada objeto del dispositivo al que se puede dar formato. (Si esta opción no existe, el comando format está disponible para todos los objetos).

Requisitos

Requisito	Value
Plataforma de destino	Windows
Encabezado	portabledeviceapi.h
Library	PortableDeviceGUIDs.lib

Consulte también

IPortableDeviceCapabilities (Interfaz)