MobjAlloc

Filters
See also

User Guide:

Message mailboxes

Reference:

MbufAlloc1d MobjControl MobjFree MobjInquire MobjMessageRead MobjMessageWrite MsysAlloc

Availability

Available in MIL-Lite

Available in MIL

Available on Windows

Available on Linux

Available on Non-Matrox computer

Available on Matrox 4Sight-X

Available on Matrox 4Sight GP/GPm

Available on Matrox Supersight

Function map

Examples

None.

Function Map

- SysId

Table:

For specifying the system

- ObjectType

- InitFlag

- ObjIdPtr

Parameter Associations

Table:

For specifying the type of MIL utility object to allocate

Return value

Compilation information

Synopsis

Allocate a MIL utility object for a Distributed MIL publishing application.

Syntax

MIL_ID MobjAlloc(

MIL_ID SysId,	//in
MIL_INT64 ObjectType,	//in
MIL_INT64 InitFlag,	//in
MIL_ID *ObjIdPtr	//out

)

Description

This function allocates a MIL utility object (for example, a message mailbox) for a publishing application within a Distributed MIL monitoring configuration. You can control and inquire a MIL utility object using MobjControl() and MobjInquire(), respectively. When the MIL utility object is no longer required, release it, using MobjFree().

Note, to allocate all other MIL objects that this module can manipulate, use the allocation function of the object's corresponding MIL module (for example, to allocate an image buffer, use MbufAlloc...()).

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see if there is complementary information.

Parameters

This function is not supported on the selected boards.

Parameters

SysId

Specifies the system on which to allocate the MIL utility object. This parameter should be set to one of the following values:

For specifying the system
Value	Description
M_DEFAULT_HOST	Specifies the default Host system of the current MIL application.
MIL system identifier	Specifies a valid system identifier, previously allocated using MsysAlloc().

ObjectType

Specifies the type of MIL utility object to allocate.

See the Parameter associations section for possible values that can be specified.

InitFlag INQ

Specifies the initialization of the MIL utility object.

See the Parameter associations section for possible values that can be specified.

ObjIdPtr

Specifies the address in which to return the identifier of the allocated MIL utility object. Since MobjAlloc() also returns the identifier, you can set this parameter to M_NULL.

Parameter associations

The table below lists possible values for the ObjectType and InitFlag parameters.

For specifying the type of MIL utility object to allocate

For specifying the type of MIL utility object to allocate
ObjectType		Description
	InitFlag	Description
M_MESSAGE_MAILBOX		Creates a message mailbox. You can read from a message mailbox using MobjMessageRead() and write to a message mailbox using MobjMessageWrite(). (summarize) Creates a message mailbox. (more details...)
	M_DEFAULT	Same as M_QUEUE.
	M_OVERWRITE	Specifies that only one message can be kept in the mailbox and is replaced at each write. The message is kept after a read operation. (summarize) Specifies that only one message can be kept in the mailbox and is replaced at each write. (more details...)
	M_QUEUE	Specifies that multiple messages can be queued in the mailbox. Messages are read on a FIFO basis. Upon a read operation, a message is removed from the queued message mailbox by default. To keep a message in the queued message mailbox after a read operation, call MobjMessageRead() with M_KEEP_IN_QUEUE. (summarize) Specifies that multiple messages can be queued in the mailbox. (more details...)

Return value

The returned value is the MIL utility object identifier if the allocation is successful. If allocation fails, M_NULL is returned.

Compilation information

Header	Include mil.h.
Library	Use mil.lib.
DLL	Requires mil.dll.