Edit

INetFwPolicy::GetProfileByType method (netfw.h)

  • Article

[The Windows Firewall API is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions. For Windows Vista and later, use of the Windows Firewall with Advanced Security API is recommended.]

Retrieves the profile of the requested type.

Syntax

HRESULT GetProfileByType(
  [in]       NET_FW_PROFILE_TYPE profileType,
  [out, ref] INetFwProfile       **profile
);

Parameters

[in] profileType

Type of profile from NET_FW_PROFILE_TYPE.

[out, ref] profile

Retrieved profile of type INetFwProfile.

Retrieved profile of type INetFwProfile.

Return value

C++

Return code Description
E_ACCESSDENIED
 The operation was aborted due to permissions issues.
E_INVALIDARG
 The method failed due to an invalid parameter.
E_OUTOFMEMORY
 The method was unable to allocate required memory.
E_POINTER
 The method failed due to an invalid pointer.
 

VB

If the method succeeds, the return value is S_OK.

If the method fails, the return value is one of the following error codes.

Return code Description
E_ACCESSDENIED
 The operation was aborted due to permissions issues.
E_INVALIDARG
 The method failed due to an invalid parameter.
E_OUTOFMEMORY
 The method was unable to allocate required memory.
E_POINTER
 The method failed due to an invalid pointer.

Requirements

Requirement Value
Minimum supported client Windows Vista, Windows XP with SP2 [desktop apps only]
Minimum supported server Windows Server 2003 with SP1 [desktop apps only]
Target Platform Windows
Header netfw.h
DLL FirewallAPI.dll; Hnetcfg.dll on Windows XP with SP2

See also

INetFwPolicy

INetFwProfile

NET_FW_PROFILE_TYPE