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

La méthode GetCommandOptions récupère toutes les options prises en charge pour la commande spécifiée sur l’appareil.

Syntaxe

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

Paramètres

[in] Command

REFPROPERTYKEY qui spécifie une commande pour interroger les options prises en charge. Pour obtenir la liste des commandes définies par les appareils portables Windows, consultez Commandes.

[out] ppOptions

Adresse d’une variable qui reçoit un pointeur vers une interface IPortableDeviceValues qui contient les options prises en charge. Si aucune option n’est prise en charge, elle ne contient aucune valeur. L’appelant doit libérer cette interface lorsqu’il a terminé avec elle. Pour plus d'informations, consultez la section Notes.

Valeur retournée

Cette méthode retourne un code HRESULT. Les valeurs possibles sont notamment celles figurant dans le tableau suivant.

Remarques

Cette méthode est appelée par les applications qui souhaitent appeler une commande directement sur le pilote en appelant IPortableDevice ::SendCommand. Certaines commandes permettent à l’appelant de spécifier des options supplémentaires. Par exemple, certains pilotes prennent en charge la suppression enfant récursive lors de la suppression d’un objet à l’aide de la commande WPD_COMMAND_OBJECT_MANAGEMENT_DELETE_OBJECTS.

Si une option est une valeur booléenne simple, la clé de l’interface IPortableDeviceValues récupérée sera le nom de l’option, et la valeur PROPVARIANT sera une valeur VT_BOOL true ou false. Si une option a plusieurs valeurs, la valeur PROPVARIANT récupérée est un type de collection qui contient les valeurs prises en charge.

Si cette méthode est appelée pour la commande WPD_COMMAND_STORAGE_FORMAT et que le paramètre ppOptions est défini sur WPD_OPTION_VALID_OBJECT_IDS, le pilote retourne une collection IPortableDevicePropVariant de type VT_LPWSTR qui spécifie les identificateurs de chaque objet sur l’appareil qui peut être mis en forme. (Si cette option n’existe pas, la commande de format est disponible pour tous les objets.)

Configuration requise

Voir aussi

IPortableDeviceCapabilities, interface