Overview
C API (Core)
struct CreateUtility { Symbol hCaller; Symbol hUtility; ComponentSpec spec; const char* name; HandledEvent* handledEvent; }; Symbol brahms_createUtility(struct CreateUtility* data);

Create a Utility component for the exclusive use of the caller, and prepare a HandledEvent to allow the caller to access the Utility directly.

Arguments

Symbol hCaller IN
A handle to the calling process.
Symbol hUtility OUT
The handle of the new Utility is returned, here (also as the return value of the call). This must be S_NULL when the call is made.
ComponentSpec spec IN
The SystemML class and release that is required to be supported by the new Utility. The actual Utility object created may not be exactly that specified, but it will support the requested interface.
const char* name IN
A name to give to the new Utility, or NULL.
HandledEvent* handledEvent IN/OUT
A handled event to be filled for the utility, or NULL to not return a handled event.

Return Values

See also General API Return Values.

Result

  • The new Utility component is returned.
  • If a name was specified, the new component is named XXX:YYY where XXX is the name of the calling component and YYY is the specified name. If a name was not specified, the new component is named XXX:ZZZ where ZZZ is the class of the new Utility.