3.2.4.130 R_DhcpV4EnumPoliciesEx (Opnum 129)

The R_DhcpV4EnumPoliciesEx method returns an enumerated list of all configured server level or scope level policies. The caller of this method can free the memory pointed to by the EnumInfo parameter by calling the midl_user_free function (section 3).

The R_DhcpV4EnumPoliciesEx method is an extension of the R_DhcpV4EnumPolicies (Opnum 112) (section 3.2.4.130) method, where an array of DHCP_POLICY_EX (section 2.2.1.2.121) structures is enumerated, rather than an array of DHCP_POLICY (section 2.2.1.2.110) structures. Each DHCP_POLICY_EX structure contains a list of DHCP_PROPERTY (section 2.2.1.2.117) elements that are associated with the given policy.

 DWORD R_DhcpV4EnumPoliciesEx(
   [in, unique, string] DHCP_SRV_HANDLE ServerIpAddress,
   [in, out] LPDWORD ResumeHandle,
   [in] DWORD PreferredMaximum,
   [in] BOOL ServerPolicy,
   [in] DHCP_IP_ADDRESS SubnetAddress,
   [out] LPDHCP_POLICY_EX_ARRAY EnumInfo,
   [out] DWORD* ElementsRead,
   [out] DWORD* ElementsTotal
 );

ServerIpAddress: As specified in R_DhcpV4EnumPolicies (Opnum 112).

ResumeHandle: As specified in R_DhcpV4EnumPolicies (Opnum 112).

PreferredMaximum: As specified in R_DhcpV4EnumPolicies (Opnum 112).

ServerPolicy: As specified in R_DhcpV4EnumPolicies (Opnum 112).

SubnetAddress: As specified in R_DhcpV4EnumPolicies (Opnum 112).

EnumInfo: This out parameter contains an array of DHCP_POLICY_EX structures containing an enumerated list of all configured server-level or scope-level policies for the given property. The DHCP_PROPERTY elements that are enumerated are as follows:

DNSSuffix: Specifies the DNSSuffix for the policy when the DHCP_PROPERTY_ID (section 2.2.1.1.27) is DhcpPropIdPolicyDnsSuffix and the value of the DHCP_PROPERTY_TYPE (section 2.2.1.1.26) is DhcpPropTypeString.

ElementsRead: As specified in R_DhcpV4EnumPolicies (Opnum 112).

ElementsTotal: As specified in R_DhcpV4EnumPolicies (Opnum 112).

Return Values: As specified in R_DhcpV4EnumPolicies (Opnum 112).

The opnum field value for this method is 129.

The remainder of the processing behavior for this method is as defined for the R_DhcpV4EnumPolicies method, except as follows:

  • No filtering is applied to the enumerated list of configured server-level or scope-level policies returned by the R_DhcpV4EnumPoliciesEx method.