Adicionar uma propriedade IDL

O assistente Adicionar propriedade IDL adiciona uma propriedade a uma interface definida em uma biblioteca de definição de interface (IDL), como em um projeto ATL que contém um .idl arquivo. Este assistente não está disponível em projetos que suportam MFC.

Este assistente difere do assistente Adicionar Propriedade e do assistente Adicionar Propriedade IDL MFC das seguintes maneiras:

• O assistente Adicionar propriedade adiciona uma propriedade a uma interface em seu projeto.
• O assistente Adicionar IDL MFC Property é específico para projetos MFC, ActiveX ou ATL que suportam MFC.

Para adicionar uma propriedade IDL

1. No menu Ver, selecione Vista de Classes.

2. No Modo de Exibição de Classe, clique com o botão direito do mouse no nome da interface à qual você deseja adicionar a propriedade.

   Observação

   Você também pode adicionar propriedades a dispinterfaces, que, a menos que o projeto seja atribuído, ficam aninhados no nó da biblioteca.

3. Clique com o botão direito do mouse no nome da interface.

4. No menu de atalho, selecione Adicionar>Adicionar Propriedade.

5. No assistente Adicionar propriedade IDL, forneça as informações para criar a propriedade.

6. Selecione OK para adicionar a propriedade.

Os métodos Get e Put da propriedade são exibidos como dois ícones na Exibição de Classe sob a interface onde está definida. Clique duas vezes em qualquer um dos ícones para exibir a declaração de propriedade no .idl arquivo.

Para interfaces ATL, as funções Get e Put são adicionadas aos arquivos .cpp e .h.

Adicionar um assistente de propriedade IDL

A seção a seguir descreve a interface do usuário que você usará para adicionar uma propriedade IDL:

• Nome da propriedade

  Define o nome da propriedade.

• Tipo de propriedade

  O tipo de dados da propriedade.

• Tipo de retorno

  Para interfaces ATL, define o tipo de retorno para a propriedade. Para interfaces duplas, HRESULT é sempre o tipo de retorno, e a opção de seleção não está disponível. Para interfaces personalizadas, você pode selecionar um tipo de retorno na lista. HRESULT ainda é recomendado, pois fornece uma maneira padrão de retornar erros.

• Obter função

  Para as interfaces ATL, cria o método Get para recuperar o valor da propriedade. Selecione Obter, Colocar ou ambos.

• Função Put

  Para interfaces ATL, cria o Put método para definir o valor da propriedade. Selecione Obter, Colocar ou ambos. Se você selecionar a função Put, poderá escolher entre as duas maneiras a seguir para implementar o método:

  Opção	Descrição
  propput	A PropPut função retorna uma cópia do objeto. propput é o padrão e a maneira mais comum de tornar a propriedade escriturável.
  propputref	A PropPutRef função retorna uma referência ao objeto, em vez de retornar a cópia do próprio objeto. Considere o uso da propputref opção para objetos, como grandes estruturas ou matrizes, que possam ter sobrecarga de inicialização.

• Parâmetros

  Exibe a lista de parâmetros adicionados à propriedade. Cada item na lista consiste no nome do parâmetro, tipo de parâmetro e atributos.

  in Indica que o parâmetro é passado do procedimento de chamada para o procedimento chamado. out Indica que o parâmetro pointer é retornado do procedimento chamado para o procedimento de chamada (do servidor para o cliente).

• +

  Adicione um parâmetro. Em Parâmetros, digite o tipo e o nome do parâmetro. Por exemplo, int xe selecione OK.

• x

  Remove o parâmetro selecionado de Parameters.

• Ícone de lápis

  Edite o parâmetro selecionado.

• Atributos

1. helpcontext

   Especifica uma ID de contexto que permite ao usuário exibir informações sobre essa propriedade no arquivo de Ajuda. Para obter mais informações, consulte helpcontext.

2. helpstring

   Especifica uma cadeia de caracteres usada para descrever o elemento ao qual ela se aplica. Por padrão, ele é definido como propertyNome da propriedade. Para obter mais informações, consulte helpstring.

3. id

   Define o identificador numérico que identifica a propriedade. Esta opção não está disponível para propriedades de interfaces personalizadas. Para obter mais informações, consulte id.

• Atributos adicionais

Palavras-chave na Microsoft Interface Definition Language (MIDL) são descritas em detalhes na referência da linguagem MIDL.

Ver também

Adicionar propriedade
Adicionar propriedade IDL MFC