Unit 'Intuition' Package
[Overview][Constants][Types][Procedures and functions][Variables][Index] [#aros]

ModifyIDCMP

Modify the state of a window's IDCMPFlags.

Declaration

Source position: intuition.pas line 3212

function ModifyIDCMP(

  Window: PWindow;

  Flags: LongWord

):LongBool;

Arguments

Window

  

A pointer to the Window structure containing the IDCMP ports

Flags

  

The flag bits describing the new desired state of the IDCMP. (IDCMP_*)

Function result

This function returns False if it was unable to create the necessary message ports.

Description

This routine modifies the state of your window's IDCMP (Intuition Direct Communication Message Port). The state is modified to reflect your desires as described by the flag bits in the value IDCMPFlags.

The four actions that might be taken are:

Note: You can set up the Window^.UserPort to any port of your own before you call ModifyIDCMP(). If IDCMPFlags is non-null but your UserPort is already initialized, Intuition will assume that it's a valid port with task and signal data preset and Intuition won't disturb your set-up at all, Intuition will just allocate the Intuition message port half of it. The converse is true as well: if UserPort is nil when you call here with IDCMPFlags = 0, Intuition will deallocate only the Intuition side of the port.

This allows you to use a port that you already have allocated:

For an example of how to close a window with a shared IDCMP, see the description for CloseWindow().

See also

OpenWindow

  

Open an Intuition window.

CloseWindow

  

Close an Intuition window.


Documentation generated on: 2021-07-30