CDE/cde/doc/C/guides/man/man4/Get_Icon.sgm

<!-- $XConsortium: Get_Icon.sgm /main/5 1996/08/30 14:48:56 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->

<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN287.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN287.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Get_Iconified</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Get_Iconified</Symbol></RefName>
<RefPurpose>get a tool's iconic state
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Get_Icon.sgm /main/5 1996/08/30 14:48:56 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>Get_Iconified(out boolean <Emphasis>iconic</Emphasis>
        [in messageID <Emphasis>commission</Emphasis>]);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Get_Iconified</Symbol> request
reports the iconic state of the optionally specified
window, or of the window primarily associated with the handling
procid (if no window is specified).
</Para>
<Para>The
<Emphasis>iconic</Emphasis> argument
is a Boolean value indicating whether the specified window is (to be)
iconified.
</Para>
<Para>The
<Emphasis>commission</Emphasis> argument
is the ID of the ongoing request, if any, that resulted in the creation
of the window(s) in question.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.session.join;, and
&cdeman.ttdt.message.accept;, functions can be used by Xt applications to register for,
and transparently process, the
<Symbol Role="Message">Get_Iconified</Symbol> request.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.ttdt.message.accept;, &cdeman.ttdt.session.join;; <Symbol Role="Message">Set_Iconified</Symbol> request.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->