Partager via


Méthode IDiscFormat2TrackAtOnce::p ut_ClientName (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
Impossible d’allouer la mémoire requise.

Valeur : 0x8007000E

E_IMAPI_DF2TAO_CLIENT_NAME_IS_NOT_VALID
Le nom du client n’est pas valide.

Valeur : 0xC0AA050F

E_IMAPI_DF2TAO_WRITE_IN_PROGRESS
Une opération d’écriture est en cours.

Valeur : 0xC0AA0500

E_IMAPI_DF2TAO_MEDIA_IS_PREPARED
L’opération demandée n’est pas valide lorsque le média a été « préparé » mais pas publié.

Valeur : 0xC0AA0503

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’écriture peut utiliser le code de contrôle IOCTL_CDROM_EXCLUSIVE_ACCESS (requête) (voir Microsoft Windows Driver Development Kit (DDK)) pour accéder au nom, il est important que le nom identifie le programme qui utilise cette interface pour écrire sur le support. Le nom est limité au même jeu de caractères que celui requis par le code de contrôle IOCTL_CDROM_EXCLUSIVE_ACCESS.

Spécifications

   
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

IDiscFormat2TrackAtOnce

IDiscFormat2TrackAtOnce::get_ClientName