Compartilhar via


Método IDiscFormat2Data::p ut_ClientName (imapi2.h)

Define o nome amigável do cliente.

Sintaxe

HRESULT put_ClientName(
  [in] BSTR value
);

Parâmetros

[in] value

Nome do aplicativo cliente. Não pode ser NULL ou uma cadeia de caracteres vazia.

Retornar valor

S_OK é retornado com êxito, mas outros códigos de êxito podem ser retornados como resultado da implementação. Os seguintes códigos de erro geralmente são retornados em caso de falha na operação, mas não representam os únicos valores de erro possíveis:

Código de retorno Descrição
E_OUTOFMEMORY
Falha ao alocar a memória necessária.

Valor: 0x8007000E

E_IMAPI_DF2DATA_CLIENT_NAME_IS_NOT_VALID
O nome do cliente não é válido.

Valor: 0xC0AA0211

E_IMAPI_DF2DATA_WRITE_IN_PROGRESS
Atualmente, há uma operação de gravação em andamento.

Valor: 0xC0AA0500

Comentários

O nome é usado quando a operação de gravação solicita acesso exclusivo ao dispositivo. A propriedade IDiscRecorder2::get_ExclusiveAccessOwner contém o nome do cliente que tem o bloqueio.

Como qualquer aplicativo com acesso de leitura/gravação ao dispositivo CDROM durante a operação de gravação pode usar o código de controle IOCTL_CDROM_EXCLUSIVE_ACCESS (consulta) (consulte o DDK (Microsoft Windows Driver Development Kit)) para acessar o nome, é importante que o nome identifique o programa que está usando essa interface para gravar na mídia. O nome é restrito ao mesmo conjunto de caracteres exigido pelo código de controle IOCTL_CDROM_EXCLUSIVE_ACCESS.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows Vista, Windows XP com SP2 [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho imapi2.h

Confira também

IDiscFormat2Data

IDiscFormat2Data::get_ClientName