IAdmPropertyPatternConstraint
The IAdmPropertyPatternConstraint interface is the base interface for all constraints that are used in property patterns. All interfaces that represent different types of constraints are inherited from this interface.
Inheritance: IUnknown
Derived: IAdmStringValueConstraint, IAdmValueLengthConstraint, IAdmValueRangeConstraint, IAdmRegexpConstraint
Methods
-
Method
-
Description
-
Check()
-
Determines whether a given property entry meets the requirements of this constraint.
Properties
-
Property
-
Description
-
Description
-
Gets a description of the constraint.
-
DescriptionXml
-
Gets a description of the constraint in the XML format.
-
Type
-
Gets the constraint type.
-
Category
-
Gets the constraint category.
Details
Check()
Determines whether a given property entry meets the requirements of this constraint.
bool Check(IADsPropertyEntry propertyEntry,
IAdmTop targetObject,
out string errorMessage)
Parameters
- propertyEntry – the property entry to check.
- targetObject – the target directory object.
- errorMessage – an output (OUT) parameter that returns an error message when the method returns
false. If the method returnstrue, this parameter returnsnull.
Description
Gets a description of the constraint.
- Type:
- string
- Access:
- Read-only
DescriptionXml
Gets a description of the constraint in the XML format.
- Type:
- string
- Access:
- Read-only
Type
Gets the constraint type.
- Type:
- ADM_PROPERTYCONSTRAINTTYPE_ENUM
- Access:
- Read-only
Category
Gets the constraint category.
- Type:
- ADM_PROPERTYCONSTRAINTCATEGORY_ENUM
- Access:
- Read-only
Requirements
Minimum required version: 2009.1