IDiscFormat2Data::put_ClientName method (imapi2.h)

Article
02/22/2024

Sets the friendly name of the client.

Syntax

HRESULT put_ClientName(
  [in] BSTR value
);

Parameters

[in] value

Name of the client application. Cannot be NULL or an empty string.

Return value

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
E_OUTOFMEMORY	Failed to allocate the required memory. Value: 0x8007000E
E_IMAPI_DF2DATA_CLIENT_NAME_IS_NOT_VALID	The client name is not valid. Value: 0xC0AA0211
E_IMAPI_DF2DATA_WRITE_IN_PROGRESS	There is currently a write operation in progress. Value: 0xC0AA0500

Remarks

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.

Requirements

Requirement	Value
Minimum supported client	Windows Vista, Windows XP with SP2 [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	imapi2.h