Class UserSubroutineAPI

Namespace: VM.API.Pre
Assembly: VM.API.Pre.dll

This class implements APIs for class.

public static class UserSubroutineAPI

Inheritance

object ← UserSubroutineAPI

Extension Methods

LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType), LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType), LinkPropertyItemCache.GetLinkedObjects<T>(object, LinkPropertyType)

Methods

CreateUserSubroutine(SubSystemDocument, string, string, string, IEnumerable<UserSubroutineResult>, IEnumerable<Obj>, string, bool, SymmetricType, bool)

Create .

[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

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<UserSubroutineResult>

The results of a user subroutine.

arguments IEnumerable<Obj>

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

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 .