AddInlineFunction

Description

This operation is used to register a new function alias for an inline function, so that it can be used in the Workflow designer.

Usage

NWAdmin.exe -o AddInlineFunction -functionalias functionAlias -assembly AssemblyName -namespace Namespace -typename TypeName -method MethodName [-usage Usage] [-description Description] [-lcid Lcid] [-hidden]

Parameters

Name Description

-functionalias

Required. A string that represents the name of the function alias for the inline function. The name of the function alias is used to invoke the inline function in workflow actions.

The maximum length for this parameter is 512 characters.

Note: Nintex suggests that function aliases for inline functions use 15 characters or less, if possible.

-assembly

Required. A string that represents the name of the assembly that contains the type and method for the inline function. If the type and method is not contained in the .NET Framework core library (mscorlib), use the fully-qualified four-part name of the assembly; otherwise, specify mscorlib.

The maximum length of this parameter is 512 characters.

-namespace

Required. A string that represents the fully-qualified name of the namespace, in the assembly specified in assembly, that contains the type and method for the inline function.

The maximum length for this parameter is 512 characters.

-typename

Required. A string that represents the unqualified type name of the static class that contains the method for the inline function.

The maximum length for this parameter is 512 characters.

-method

Required. A string that represents the unqualified member name of the public static method, in the type specified in type, for the inline function.

The maximum length for this parameter is 512 characters.

Note: Do not specify additional syntax elements, such as parameters. Nintex Workflow 2013 uses reflection to identify additional syntax elements for the member specified in this parameter.

-usage

Optional. A string that represents the description of the syntax information for the function alias.

The maximum length for this parameter is 500 characters.

-description

Optional. A string that represents the description of the function alias.

The maximum length for this parameter is 500 characters.

-lcid

Optional. An integer that represents the locale identifier of the function alias. The default value is null.

Note: Duplicate function aliases are not allowed, even if the locale identifiers are different.

-hidden

Optional. Indicates whether the function alias is displayed in Workflow designer. If specified, the function alias is not displayed in Workflow designer; otherwise, the function alias is displayed.

Note: This parameter does not affect whether the function alias is displayed in the output of the EnumInlineFunctions operation. For more information, see EnumInlineFunctions.

Remarks

You can add multiple aliases for a single inline function by running this operation for each new function alias, specifying a different value for the functionalias parameter for each one. Duplicate alias values are not allowed, however, even if different locale identifiers are specified.

For more information about inline functions, including how to develop, define, and invoke custom inline functions, see the Nintex Workflow SDK. To access Nintex SDKs, go to help.nintex.com.