Agregar una propiedad IDL

El Asistente para agregar propiedad IDL agrega una propiedad a una interfaz definida en una biblioteca de definiciones de interfaz (IDL), como en un proyecto ATL que contiene un archivo .idl. Este asistente no está disponible en proyectos que admiten MFC.

Este asistente difiere del asistente para agregar propiedad y del Asistente para Agregar propiedad IDL MFC de las siguientes maneras:

• El Asistente para agregar una propiedad agrega una propiedad a una interfaz del proyecto.
• El asistente para Agregar propiedad IDL MFC es específico de los proyectos MFC, ActiveX o ATL que admiten MFC.

Para agregar una propiedad IDL

1. En el menú Ver, seleccione Vista de clases.

2. En la Vista de clases, haga clic con el botón derecho en la interfaz a la que quiera agregar la propiedad.

   Nota:

   También puede agregar propiedades a interfaces dispinterface que, a menos que el proyecto tenga atributos, se anidan bajo el nodo de biblioteca.

3. Haga clic con el botón derecho en el nombre de la interfaz.

4. En el menú contextual, seleccione Agregar>Agregar propiedad.

5. En el asistente para Agregar propiedad IDL, proporcione la información para crear la propiedad.

6. Seleccione Aceptar para agregar la propiedad.

Los métodos Get y Put de la propiedad se muestran como dos iconos en la Vista de clases, en la interfaz donde se ha definido. Haga doble clic en cualquiera de los iconos para ver la declaración de propiedad en el archivo .idl.

En las interfaces ATL, se agregan las funciones Get y Put a los archivos .cpp y .h.

Asistente para agregar una propiedad IDL

En la sección siguiente se describe la interfaz de usuario que va a usar para agregar una propiedad IDL:

• Nombre de propiedad

  Establece el nombre de la propiedad.

• Tipo de propiedad

  El tipo de datos de la propiedad.

• Tipo de valor devuelto

  En el caso de las interfaces ATL, establece el tipo de valor devuelto para la propiedad. Para las interfaces duales, HRESULT siempre es el tipo de valor devuelto y la opción de selección no está disponible. Para las interfaces personalizadas, puede seleccionar un tipo de valor devuelto de la lista. Se sigue recomendando HRESULT, ya que proporciona una manera estándar de devolver errores.

• Get (función)

  En el caso de las interfaces ATL, crea el método Get para recuperar el valor de la propiedad. Seleccione Get, Put o ambas.

• Put (función)

  En el caso de las interfaces ATL, crea el método Put para establecer el valor de la propiedad. Seleccione Get, Put o ambas. Si se selecciona la función Put, se puede elegir entre las dos maneras siguientes de implementar el método:

  Opción	Descripción
  propput	La función PropPut devuelve una copia del objeto. propput es el valor predeterminado y la manera más común de convertir la propiedad en grabable.
  propputref	La función PropPutRef devuelve una referencia al objeto, en lugar de devolver la copia del propio objeto. Considere el uso de la opción propputref para los objetos, como estructuras o matrices grandes, que puedan tener sobrecarga de inicialización.

• Parámetros

  Muestra la lista de parámetros agregados a la propiedad. Cada elemento de la lista está formado por el nombre del parámetro, el tipo y los atributos.

  in indica que el parámetro se pasa del procedimiento que realiza la llamada al procedimiento que se llama. out indica que el parámetro de puntero se devuelve desde el procedimiento llamado al procedimiento que realiza la llamada (desde el servidor al cliente).

• +

  Agregue un parámetro. En Parámetros, escriba el tipo de parámetro y el nombre. Por ejemplo, int x, y seleccione Aceptar.

• x

  Quita el parámetro seleccionado de Parámetros.

• Icono de lápiz

  Edite el parámetro seleccionado.

• Atributos

1. helpcontext

   Especifica un id. de contexto que permite al usuario ver información sobre esta propiedad en el archivo de ayuda. Para más información, consulte helpcontext.

2. helpstring

   Especifica una cadena de caracteres que se usa para describir el elemento al que se aplica. De forma predeterminada, se establece en propertyNombre de propiedad. Para más información, consulte helpstring.

3. id

   Establece el identificador numérico que identifica la propiedad. Esta opción no está disponible para las propiedades de interfaces personalizadas. Para más información, consulte id.

• Atributos adicionales

Las palabras clave del Lenguaje de definición de interfaz de Microsoft (MIDL) se describen en detalle en Referencia del lenguaje MIDL.

Opción	Descripción
bindable	Indica que la propiedad admite enlace de datos. Para más información, consulte bindable.
defaultbind	Indica que esta propiedad enlazable única representa mejor al objeto. Para obtener más información, vea defaultbind.
defaultcollelem	Indica que la propiedad es una función de descriptor de acceso para un elemento de la colección predeterminada. Para más información, consulte defaultcollelem.
displaybind	Indica que esta propiedad se debe mostrar al usuario como enlazable. Para más información, consulte displaybind.
hidden	Indica que la propiedad existe, pero que no se debe mostrar en un explorador orientado al usuario. Para más información, consulte hidden.
immediatebind	Indica que todos los cambios en esta propiedad de un objeto enlazado a datos se notificarán inmediatamente a la base de datos. Para más información, consulte immediatebind.
local	Especifica al compilador de MIDL que la propiedad no es remota. Para más información, consulte local.
nonbrowsable	Etiqueta a un miembro de interfaz o de interfaz dispinterface que no se debe mostrar en un explorador de propiedades. Para más información, consulte nonbrowsable.
requestedit	Indica que la propiedad admite la notificación OnRequestEdit. Para más información, consulte requestedit.
restricted	Especifica que no se puede llamar a la propiedad de forma arbitraria. Para más información, consulte restricted.
source	Indica que un miembro de la propiedad es un origen de eventos. Para más información, consulte source.

Consulte también

Agregar propiedad
Agregar propiedad IDL MFC