## On this page

  

 

 # Class UserSubroutineAPI

 Last update: 09.03.2026 

<a id="VM_API_Pre_UserSubroutineAPI"></a>

Namespace: [VM.API.Pre](VM.API.Pre.md)  
Assembly: VM.API.Pre.dll

This class implements APIs for  class.

```csharp
public static class UserSubroutineAPI

```

#### Inheritance

object ← [UserSubroutineAPI](VM.API.Pre.UserSubroutineAPI.md)

#### Extension Methods

[LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkProperties_System_Object_VM_Models_Pre_LinkPropertyType_), [LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkPropertiesAndValues_System_Object_VM_Models_Pre_LinkPropertyType_), [LinkPropertyItemCache.GetLinkedObjects&lt;T&gt;(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkedObjects__1_System_Object_VM_Models_Pre_LinkPropertyType_)

## Methods

### <a id="VM_API_Pre_UserSubroutineAPI_CreateUserSubroutine_VM_Managed_DAFUL_SubSystemDocument_System_String_System_String_System_String_System_Collections_Generic_IEnumerable_VM_API_Pre_UserSubroutineResult__System_Collections_Generic_IEnumerable_VM_API_Pre_Obj__System_String_System_Boolean_VM_Managed_SymmetricType_System_Boolean_"></a> CreateUserSubroutine(SubSystemDocument, string, string, string, IEnumerable&lt;UserSubroutineResult&gt;, IEnumerable&lt;Obj&gt;, string, bool, SymmetricType, bool)

Create .

```csharp
[NotNull(new string[] { "document" })]
[NotNullOrEmpty(new string[] { "functionName", "dllName" })]
public static Obj CreateUserSubroutine(this SubSystemDocument document, string functionName, string dllName, string parameter = "", IEnumerable<UserSubroutineResult> results = null, IEnumerable<Obj> arguments = null, string name = "", bool isReportOnly = true, SymmetricType symmetricType = SymmetricType.None, bool isInterface = false)

```

#### Parameters

`document` [SubSystemDocument](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/Data/VMDFBase/SubSystemDocument.cs)

The document to create a user subroutine.

`functionName` string

The function name of a user subroutine.

`dllName` string

The dll name of the user subroutine. the input file type is 'dll' or 'so'.

`parameter` string

The parameter of a user subroutine..

`results` IEnumerable&lt;[UserSubroutineResult](VM.API.Pre.UserSubroutineResult.md)&gt;

The results of a user subroutine.

`arguments` IEnumerable&lt;[Obj](VM.API.Pre.Obj.md)&gt;

The expressions of a user subroutine..

`name` string

The name of a user subroutine.

`isReportOnly` bool

'true' if it is report Only. Otherwise, 'false'.

`symmetricType` SymmetricType

The symmetric type of the new

`isInterface` bool

'true' if it is interface body. Otherwise, 'false'.

#### Returns

[Obj](VM.API.Pre.Obj.md)

The new  object that is created by this API.

#### Exceptions

ArgumentNullException

Will be thrown if 'document', 'functionName', 'dllName' argument is null.

ArgumentException

Will be thrown if the extension of 'dllName' is not 'dll', 'so'.

ArgumentException

Will be thrown if the type of 'arguement' is not .