MfuncAlloc

Specifies the name of the user-defined function.

For specifying the name of the user-defined function
Value	Description
MIL_TEXT("FunctionName") 1	Specifies the name of the user-defined function. This is the same as the name of the current master function. This is also the name that you will use to call the user-defined MIL function in your application. The name of the function must be a null-terminated string. (summarize) Specifies the name of the user-defined function. (more details...)

¹ If you are passing the value in a variable, don't enclose it in MIL_TEXT().

Specifies the number of parameters passed to the current user-defined function. Note that the number of parameters should not exceed 16.

Specifies the address of the slave function.

The slave function must be declared as follows:

If your slave function will be executed by a system with an on-board processor or if the your slave function's code will be compiled into a library file, you can set this parameter to M_NULL.

Specifies the name of the library file which contains the slave function's code. The library file must be visible to the system executing the slave function.

When developing a user-defined MIL function which will be used in a Distributed MIL application, it is recommended that a copy of the library file be placed on all the remote systems in the cluster, in a directory which is part of the system's path environment variable.

If the library file is not located in a directory which is part of the path environment variable, you can alternatively provide the full path to the file.

If your slave function will be executed by a system with an on-board processor or if the your slave function's code will be included in your application, you can set this parameter to M_NULL.

Specifies the name of the slave function to export from the library file.

This parameter must be set if a library file is provided to the SlaveFunctionDLLName parameter.

If your slave function will be executed by a system with an on-board processor or if the your slave function's code will be included in your application, you can set this parameter to M_NULL.

Specifies the opcode to use to locate the slave function when an application executes the user-defined MIL function. The slave function's opcode also serves to identify which user-defined module, if any, the user-defined function belongs to.

To specify a label identifying that the function is ungrouped, or a label identifying the module in which the function is grouped, specify one of the following:

For specifying the label identifying that the function is grouped or ungrouped
Value	Description
M_USER_FUNCTION +	Specifies that the user-defined function is an ungrouped user-defined function. You must specify a combination value from the following table: To specify the offset (summarize) Specifies that the user-defined function is an ungrouped user-defined function. (more details...)
M_USER_MODULE_n +	Specifies the module in which to group the user-defined function, where n is a value between 1 and 7, inclusive. You must specify a combination value from the following table: To specify the offset (summarize) Specifies the module in which to group the user-defined function, where n is a value between 1 and 7, inclusive. (more details...)

Combination value for any of the possible values of the SlaveFunctionOpcode parameter.

You must add the following value to the above-mentioned values to specify the offset.

For specifying the offset
Combination value	Description
0 <= Value <= 63	Specifies the offset of the user-defined function among the ungrouped functions or among the functions in a specified group. When allocating multiple user-defined functions in a single user-defined module, you must set a different offset for each new function in the module. For example, M_USER_MODULE_3 + 12. To allocate a user-defined function that is not grouped in a user-defined module, use M_USER_FUNCTION + the offset; you must set a different offset for each new ungrouped function. (summarize) Specifies the offset of the user-defined function among the ungrouped functions or among the functions in a specified group. (more details...)

Specifies more information about the user-defined MIL function.

The values below allow you to set whether the slave function is executed asynchronously or synchronously.

For specifying whether the slave function is executed asynchronously or synchronously
Value	Description
M_DEFAULT	Specifies the default value. If the system on which the function context is allocated has a remote processor, the default is the same as M_ASYNCHRONOUS_FUNCTION + M_REMOTE, if the system does not have a remote processor, the default is the same as M_SYNCHRONOUS_FUNCTION + M_LOCAL. (summarize) Specifies the default value. (more details...)
M_ASYNCHRONOUS_FUNCTION +	Specifies that the user-defined function will not wait for the slave function to finish executing before executing the next function (typically MfuncFree()) in the master function. You must specify a combination value from the following table: To set whether the slave function can be executed remotely (summarize) Specifies that the user-defined function will not wait for the slave function to finish executing before executing the next function (typically MfuncFree()) in the master function. (more details...)
M_SYNCHRONOUS_FUNCTION +	Specifies that the user-defined function will wait for the slave function to finish executing before executing the next function in the master function. You must specify a combination value from the following table: To set whether the slave function can be executed remotely (summarize) Specifies that the user-defined function will wait for the slave function to finish executing before executing the next function in the master function. (more details...)

Combination values for M_ASYNCHRONOUS_FUNCTION; M_SYNCHRONOUS_FUNCTION.

You must add one of the following values to the above-mentioned values to set whether the slave function can be executed remotely.

For specifying whether the slave function can be executed remotely
Combination value	Description
M_LOCAL	Specifies that the slave function must be executed by the Host processor. Note that MIL functions called from the slave function will still be executed on their target system. This value cannot be added to M_ASYNCHRONOUS_FUNCTION. (summarize) Specifies that the slave function must be executed by the Host processor. (more details...)
M_REMOTE	Specifies that the slave function will be executed remotely, if possible. If you select M_REMOTE, but do not compile your slave function with a cross-compiler specific to the target processor, an error will be generated. For more information, see the Steps to create a user-defined MIL function section of Chapter 53: The MIL function development module. (summarize) Specifies that the slave function will be executed remotely, if possible. (more details...)

Combination values for M_SYNCHRONOUS_FUNCTION.

You can add one of the following values to the above-mentioned value to set the type of the user-defined MIL function.

Note that both M_ALLOC and M_FREE imply that the user-defined function is M_SYNCHRONOUS_FUNCTION, and cannot be added to M_ASYNCHRONOUS_FUNCTION.

For setting the type of user-defined MIL function
Combination value	Description
M_ALLOC	Specifies that the user-defined function is an allocation function, used to allocate a user-defined MIL object on a required system.
M_FREE	Specifies that the user-defined function frees an object allocated using a user-defined MIL allocation function. Note that when this value is used, the user-defined MIL function must accept the MIL identifier of the object to free as its only parameter. (summarize) Specifies that the user-defined function frees an object allocated using a user-defined MIL allocation function. (more details...)

Specifies the address of the variable in which to store the MIL identifier provided for the user-defined function. Since the MfuncAlloc() function also returns the MIL identifier, you can set this parameter to M_NULL.