IAdmArguments
The IAdmArguments interface is used to specify arguments for operation execution.
Inheritance: IUnknown
Methods
-
Method
-
Description
-
SetParameterValue()
-
Sets a value for the given parameter.
-
GetParameterValue()
-
Returns the value of the given parameter.
-
GetParameterValueAsIs()
-
Returns the value of the given parameter as it was set.
-
ResetAllParameterValues()
-
Clears values for all parameters.
-
GetParameter()
-
Returns a parameter by its name.
-
ValidateParameters()
-
Validates values of all parameters.
-
ToString()
-
Returns a string representation of the arguments.
Details
SetParameterValue()
Sets a value for the given parameter. You can use value references in the value (e.g. %username%). Value references are replaced with values of corresponding properties of the object, on which the operation is executed.
void SetParameterValue(string paramName, object value)
Parameters
- paramName - Specifies the name of the parameter for which a value is set.
- value - Specifies the value of the parameter.
GetParameterValue()
Returns the value of the given parameter. If the value is not valid for the parameter, the method throws an exception.
string GetParameterValue(string paramName, ADM_VALUETARGET_ENUM valueTarget)
Parameters
- paramName - Specifies the name of the parameter for which to return the value.
- valueTarget - If set to ADM_VALUETARGET_SEARCHFILTER, the method escapes necessary characters in the parameter value (e.g. for "John*" the method will return "John\2A") or converts a date into the format required for LDAP filters (e.g. "20180122151647.0Z").
GetParameterValueAsIs()
Returns the value of the given parameter as it was set. The method does not convert the value to string.
object GetParameterValueAsIs(string paramName)
Parameters
The paramName parameter specifies the name of the parameter for which to return the value.
ResetAllParameterValues()
Clears values for all parameters.
void ResetAllParameterValues()
GetParameter()
Returns a parameter by its name.
IAdmParameter GetParameter(string name)
Parameters
The name parameter specifies the name of the parameter to return.
ValidateParameters()
Validates values of all parameters. If a parameter value is not valid, the method throws an exception.
void ValidateParameters()
ToString()
Returns a string representation of the arguments.
string ToString(bool formatForXml)
Parameters
The formatForXml parameter specifies whether to return the arguments in XML.
Requirements
Minimum required version: 2018.2