Método IPropertyNotifySink::OnRequestEdit (ocidl.h)

  • Artigo

Notifica um coletor de que uma propriedade requestedit está prestes a ser alterada.

Sintaxe

HRESULT OnRequestEdit(
  [in] DISPID dispID
);

Parâmetros

[in] dispID

O identificador de expedição da propriedade que está prestes a ser alterada ou DISPID_UNKNOWN se várias propriedades estiverem prestes a ser alteradas.

Retornar valor

Esse método pode retornar os valores a seguir.

Código de retorno Descrição
S_OK
 A propriedade ou as propriedades especificadas têm permissão para serem alteradas.
S_FALSE
 A propriedade ou as propriedades especificadas não têm permissão para serem alteradas. O chamador deve obedecer a esse valor retornado descartando os novos valores de propriedade. Isso faz parte do contrato do atributo [requestedit] e desse método.

Comentários

O coletor pode optar por permitir ou não permitir que a alteração ocorra. Por exemplo, o coletor pode impor um estado somente leitura na propriedade . DISPID_UNKNOWN é um parâmetro válido para esse método para indicar que várias propriedades estão prestes a ser alteradas. Nesse caso, o coletor pode impor um estado somente leitura global para todas as propriedades [requestedit] no objeto, incluindo quaisquer específicas que o coletor reconheça de outra forma.

Se o coletor permitir alterações, o objeto também deverá fazer notificações IPropertyNotifySink::OnChanged para quaisquer propriedades marcadas como [associáveis] além de [requestedit].

Esse método não pode ser usado para implementar qualquer tipo de validação de dados. No momento da chamada, o novo valor desejado da propriedade não está disponível e, portanto, não pode ser validado. A única finalidade desse método é permitir que o coletor imponha um estado somente leitura em uma propriedade.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho ocidl.h

Confira também

Ipropertynotifysink