Partager via


IDiscFormat2Erase::p ut_ClientName, méthode (imapi2.h)

Définit le nom convivial du client.

Syntaxe

HRESULT put_ClientName(
  [in] BSTR value
);

Paramètres

[in] value

Nom de l’application cliente.

Valeur retournée

S_OK est retourné en cas de réussite, mais d’autres codes de réussite peuvent être retournés à la suite de l’implémentation. Les codes d’erreur suivants sont généralement retournés en cas d’échec de l’opération, mais ne représentent pas les seules valeurs d’erreur possibles :

Code de retour Description
E_OUTOFMEMORY
Échec de l’allocation de la mémoire requise.

Valeur : 0x8007000E

E_INVALIDARG
Un ou plusieurs arguments ne sont pas valides.

Valeur : 0x80070057

Notes

Le nom est utilisé lorsque l’opération d’écriture demande un accès exclusif à l’appareil. La propriété IDiscRecorder2::get_ExclusiveAccessOwner contient le nom du client qui a le verrou.

Étant donné que toute application disposant d’un accès en lecture/écriture au périphérique CDROM pendant l’opération d’effacement peut utiliser le code de contrôle IOCTL_CDROM_EXCLUSIVE_ACCESS (requête) (voir le Kit de développement du pilote Microsoft Windows (DDK)) pour accéder au nom, il est important que le nom identifie le programme qui utilise cette interface pour effacer le contenu multimédia. Le nom est limité au même jeu de caractères que celui requis par le code de contrôle IOCTL_CDROM_EXCLUSIVE_ACCESS.

Configuration requise

   
Client minimal pris en charge Windows Vista, Windows XP avec SP2 [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2003 [applications de bureau uniquement]
Plateforme cible Windows
En-tête imapi2.h

Voir aussi

IDiscFormat2Erase

IDiscFormat2Erase::get_ClientName