Skip to content

IAdmCustomCommand2

The IAdmCustomCommand2 interface extends the IAdmCustomCommand interface with the ability to configure parameters for Custom Command execution.

Inheritance: The IAdmCustomCommand2 interface inherits from the IAdmCustomCommand interface.

Methods

Properties

  • Property

  • Description

  • Parameters

  • Gets or sets an array of Custom Command parameters.

Details

CreateParameter()

Creates a Custom Command parameter of the given type.

IAdmParameter CreateParameter(ADM_PARAMETERTYPE_ENUM type)

CreateArguments()

Creates an instance of the IAdmCustomCommandArguments interface that represents Custom Command arguments.

IAdmCustomCommandArguments CreateArguments()

ResolveValueReferences()

Returns the given text with value references replaced with values of corresponding properties of the given object.

String ResolveValueReferences(IAdmTop targetObject,
                              IAdmCustomCommandArguments arguments,
                              String text,
                              out String[] warnings)

Parameters

  • targetObject - Specifies the object whose properties will be used to replace value references.
  • arguments - Specifies arguments for Custom Command execution. Before calling this method, replace value references in the arguments with values of corresponding properties of the object specified in the targetObject parameter. To replace the value references, call the IAdmCustomCommandArguments::ResolveValueReferences method.
  • text - Specifies the text in which to replace value references with property values.
  • warnings - An output (OUT) parameter that returns an array of warnings issued while resolving value references.

Parameters

Gets or sets an array of Custom Command parameters.


Requirements

Minimum required version: 2018.2

See also