Edit

DhcpHlprAddV4PolicyCondition function (dhcpsapi.h)

  • Article

The DhcpHlprAddV4PolicyCondition function allocates, initializes, and adds a DHCP server policy condition to a DHCP server policy.

Syntax

DWORD DHCP_API_FUNCTION DhcpHlprAddV4PolicyCondition(
  [in, out] LPDHCP_POLICY       Policy,
  [in]      DWORD               ParentExpr,
  [in]      DHCP_POL_ATTR_TYPE  Type,
  [in]      DWORD               OptionID,
  [in]      DWORD               SubOptionID,
  [in]      LPWSTR              VendorName,
  [in]      DHCP_POL_COMPARATOR Operator,
            LPBYTE              Value,
  [in]      DWORD               ValueLength,
  [out]     DWORD               *ConditionIndex
);

Parameters

[in, out] Policy

Pointer to a DHCP_POLICY structure that contains the policy to modify.

[in] ParentExpr

Integer that specifies the expression index that corresponds to this constituent condition.

[in] Type

DHCP_POL_ATTR_TYPE enumeration that specifies the attribute type for this condition.

[in] OptionID

DHCP_OPTION_ID value that specifies the unique option identifier for criteria based on DHCP options or sub-options.

[in] SubOptionID

DHCP_OPTION_ID value that specifies the unique sub-option identifier for criteria based on DHCP sub-options.

[in] VendorName

A pointer to a null-terminated Unicode string that represents the vendor name.

[in] Operator

DHCP_POL_COMPARATOR enumeration that specifies the comparison operator for the condition.

Value

Pointer to an array of bytes that contains the value to be used for the comparison.

[in] ValueLength

Integer that specifies the length of Value.

[out] ConditionIndex

Pointer to a DWORD that contains the newly created condition's index in the DHCP server policy.

Return value

If the function succeeds, it returns ERROR_SUCCESS.

If the function fails, it returns one of the following or an error code from DHCP Server Management API Error Codes.

Value Meaning
ERROR_INVALID_PARAMETER
 One or more of the parameters were invalid.
ERROR_NOT_ENOUGH_MEMORY
 Not enough memory available.
ERROR_DHCP_POLICY_BAD_PARENT_EXPR
 The parent expression specified does not exist.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header dhcpsapi.h
Library Dhcpsapi.lib
DLL Dhcpsapi.dll

See also

DhcpHlprAddV4PolicyExpr

DhcpHlprAddV4PolicyRange

DhcpHlprCreateV4Policy

DhcpHlprFreeV4Policy

DhcpHlprIsV4PolicySingleUC

DhcpHlprIsV4PolicyValid

DhcpHlprIsV4PolicyWellFormed

DhcpHlprModifyV4PolicyExpr

DhcpHlprResetV4PolicyExpr