Skip to content

Latest commit

 

History

History
59 lines (34 loc) · 2.88 KB

adding-a-property-visual-cpp.md

File metadata and controls

59 lines (34 loc) · 2.88 KB
description title ms.date f1_keywords helpviewer_keywords ms.custom
Learn more about: Add a property to an interface in a Microsoft Visual Studio C++ project
Add a property
04/12/2022
vc.codewiz.prop.overview
interfaces, adding properties
properties [C++], adding to interfaces
names, add property wizard
add property wizard
stock properties, about stock properties
stock properties
devdivchpfy22

Add a property

Use the Add Property wizard to add a property to an interface in your project.

To add a property to your interface:

  1. From the Visual Studio main menu, select View > Class view. In the Class View pane, expand the project node to display the interface you want to add the property to.

    [!NOTE] You can also add properties to dispinterfaces, which, unless the project is attributed, are nested within the library node.

  2. Right-click the name of interface.

  3. From the shortcut menu, select Add > Add Property.

  4. In the Add property wizard, provide the information to create the property.

  5. Select OK to add the property.

Add Property wizard

The following section describes the UI that you'll use to add a property:

:::image type="content" source="../ide/media/add-property-wizard.png" alt-text="Screenshot of Add property wizard with the method name field set to sample and the property type set to int a":::

  • Property name

    Sets the name of the property.

  • Property type

    Sets the return type of the property.

  • Get function

    Select to add a property getter. By default, the name of the Get function is GetPropertyName. You can edit this name. If you delete the name, the function GetNotSupported is inserted into the interface dispatch map. The GetPropertyName function specifies the property as readable.

    For ATL interfaces Get function makes the property readable; that is, it creates the Get method for retrieving this property from the object. Select Get, Put, or both.

  • Put function

    Select to add a property setter. By default, the name of the Set function is SetPropertyName. You can edit this name. If you delete the name, the function SetNotSupported is inserted into the interface dispatch map. The SetPropertyName function specifies that the property is writable.

    For ATL interfaces Put function makes the property writable; that is, it creates the Put method for setting, or "putting," this property of the object. Select Get, Put, or both.

See Also

Add IDL Property

Add IDL MFC Property