| UID | title | description | helpviewer_keywords | old-location | tech.root | ms.assetid | ms.date | ms.keywords | req.header | req.include-header | req.target-type | req.target-min-winverclnt | req.target-min-winversvr | req.kmdf-ver | req.umdf-ver | req.ddi-compliance | req.unicode-ansi | req.idl | req.max-support | req.namespace | req.assembly | req.type-library | req.lib | req.dll | req.irql | targetos | req.typenames | req.redist | ms.custom | f1_keywords | dev_langs | topic_type | api_type | api_location | api_name | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
NF:imapi2.IDiscFormat2Data.put_ClientName |
IDiscFormat2Data::put_ClientName (imapi2.h) |
Sets the friendly name of the client. (IDiscFormat2Data.put_ClientName) |
|
imapi\idiscformat2data_put_clientname.htm |
imapi |
1cd4ef46-4769-4e8e-80ca-fdcd81b486f1 |
12/05/2018 |
IDiscFormat2Data interface [IMAPI],put_ClientName method, IDiscFormat2Data.put_ClientName, IDiscFormat2Data::put_ClientName, imapi.idiscformat2data_put_clientname, imapi2/IDiscFormat2Data::put_ClientName, put_ClientName, put_ClientName method [IMAPI], put_ClientName method [IMAPI],IDiscFormat2Data interface |
imapi2.h |
Windows |
Windows Vista, Windows XP with SP2 [desktop apps only] |
Windows Server 2003 [desktop apps only] |
Imapi2.idl |
Windows |
19H1 |
|
|
|
|
|
|
Sets the friendly name of the client.
Name of the client application. Cannot be NULL or an empty string.
S_OK is returned on success, but other success codes may be returned as a result of implementation. The following error codes are commonly returned on operation failure, but do not represent the only possible error values:
| Return code | Description |
|---|---|
|
Failed to allocate the required memory.
Value: 0x8007000E |
|
The client name is not valid.
Value: 0xC0AA0211 |
|
There is currently a write operation in progress.
Value: 0xC0AA0500 |
The name is used when the write operation requests exclusive access to the device. The IDiscRecorder2::get_ExclusiveAccessOwner property contains the name of the client that has the lock.
Because any application with read/write access to the CDROM device during the write operation can use the IOCTL_CDROM_EXCLUSIVE_ACCESS (query) control code (see the Microsoft Windows Driver Development Kit (DDK)) to access the name, it is important that the name identify the program that is using this interface to write to the media. The name is restricted to the same character set as required by the IOCTL_CDROM_EXCLUSIVE_ACCESS control code.