Share via

INetCfgComponent::RaisePropertyUi method

  • Article

Note   This method is deprecated and should not be used.

 

The RaisePropertyUi method either determines if a network component supports a property sheet or displays the component's property sheet, allowing users to modify the component's properties.

Syntax

HRESULT RaisePropertyUi(
  [in, optional] HWND     hwndParent,
  [in]           DWORD    dwFlags,
  [in, optional] IUnknown *pUnk
);

Parameters

  • hwndParent [in, optional]
    Handle to the currently active window that owns the property sheet for a network component that RaisePropertyUi displays.

  • dwFlags [in]
    A 32-bit value that specifies whether the component supports a property sheet or whether to display the component's property sheet. This value can be one of the following values from the NCRP_FLAGS enumeration:

    Value Description

    NCRP_QUERY_PROPERTY_UI

    Determine if the component supports a property sheet.

    NCRP_SHOW_PROPERTY_UI

    If the component supports a property sheet, display it.

     

  • pUnk [in, optional]
    Pointer to the IUnknown interface. RaisePropertyUi retrieves from IUnknown the interface of the context in which to display a network component's property sheet. RaisePropertyUi uses this interface to restrict the display of the property sheet to the context of a connection.

Return value

If the NCRP_QUERY_PROPERTY_UI flag is specified, returns zero (S_OK) if successful, indicating that the component supports a property sheet; returns S_FALSE if the component does not support a property sheet; or otherwise returns NETCFG_ Xxx codes that are defined in Netcfgx.h.

If the NCRP_SHOW_PROPERTY_UI flag is specified, returns zero (S_OK) if successful, indicating that changes were applied to the component's properties; returns S_FALSE if no changes were made; or otherwise returns NETCFG_ Xxx codes that are defined in Netcfgx.h.

Remarks

The RaisePropertyUi method calls the notify object of the network component to set the appearance of the component's property sheet and to control the notify object's behavior. For example, RaisePropertyUi calls the following sequence of interface methods of the notify object:

  1. INetCfgComponentPropertyUi::QueryPropertyUi

    Determines if the given context is an appropriate context in which to display properties for the component.

  2. INetCfgComponentPropertyUi::SetContext

    Directs the component's notify object to display the component's properties in the given context.

  3. INetCfgComponentPropertyUi::MergePropPages

    Creates pages for the component's property sheet.

  4. INetCfgComponentPropertyUi::ApplyProperties

    Stores, in memory, changes to the component's network configuration that a user enters on the page.

  5. INetCfgComponentControl::ApplyRegistryChanges

    Applies the component's changes to the registry.

Requirements

Target platform

 Desktop

Header

 Netcfgx.h (include Netcfgx.h)

See also

INetCfgComponentControl::ApplyRegistryChanges

INetCfgComponentPropertyUi::ApplyProperties

INetCfgComponentPropertyUi::MergePropPages

INetCfgComponentPropertyUi::QueryPropertyUi

INetCfgComponentPropertyUi::SetContext

 

 

Send comments about this topic to Microsoft