SendMessageToChildren

Note: This page includes content based on the F1 documentation for Centura development. It may be partially converted to support APF development, but should be regarded to be of uncertain actuality. It is provided as is. Eventually, it should be replaced by documentation available from within Visual Studio.

SalBoolean SendMessageToChildren( SalNumber nChildTypes,
                               SalNumber nMessage,
                               SalNumber nwParam,
                               SalNumber nlParam )

The SendMessageToChildren sends a message to all logical children of the specified type(s).

Parameters

NameDescription
SalNumber nChildTypesTypes of logical children that shall receive the message. Specify one or more of the Const.CHILDTYPE_* constants.
SalNumber nMessageNumber of the message to send. This is typically a Const.SAM_*, Const.PM_*, or Const.PAM_* message constant.
SalNumber nwParamThe value that will be available to the receiver in the wParam system variable.
SalNumber nlParamThe value that will be available to the receiver in the lParam system variable.

Returns

The return value is true if all objects receiving the message returns a non-zero value (e.g. true), false otherwise.

Comments

The SendMessageToChildren method will always send the message to all children, regardless of the return values. To send messages in a way that the sending is aborted if any child returns false, applications should use the SendMessageToChildrenOk method.