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

<!-- $XConsortium: Status.sgm /main/5 1996/08/30 15:01:49 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.MAN315.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN315.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Status</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Status</Symbol></RefName>
<RefPurpose>a tool has some status information to announce
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Status.sgm /main/5 1996/08/30 15:01:49 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>Status(in string <Symbol Role="Variable">status</Symbol>,
        in string <Emphasis>vendor</Emphasis>,
        in string <Emphasis>toolName</Emphasis>,
        in string <Emphasis>toolVersion</Emphasis>
        [in messageID <Emphasis>commission</Emphasis>]);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Status</Symbol> notice
indicates that
a tool has status information to announce.
</Para>
<Para>The
<Symbol Role="Variable">status</Symbol> argument
is the status being announced.
</Para>
<Para>The
<Emphasis>vendor</Emphasis> argument
is the vendor of the sending tool.
</Para>
<Para>The
<Emphasis>toolName</Emphasis> argument
is the name of the sending tool.
</Para>
<Para>The
<Emphasis>toolVersion</Emphasis> argument
is the version of the sending tool.
</Para>
<Para>The
<Emphasis>commission</Emphasis> argument
is the ID of the request, if any, that initiated the operation
the status of which is being announced.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.subcontract.manage;, function can be used to register for,
and help process, the
<Symbol Role="Message">Status</Symbol> request.
</Para>
<Para>The
<Symbol Role="Message">Status</Symbol> request can be sent with
&cdeman.ttdt.message.accept;.</Para>
<Para>The
<Symbol Role="Message">Status</Symbol> notice can be used by handlers of requests invoking protracted
operations to provide periodic point-to-point status reports to the
requester.
Doing so has the nice side effect of identifying the handler to
the requester, so that the requester can issue a
<Symbol Role="Message">Quit</Symbol> request if it wants to.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.ttdt.message.accept;, &cdeman.ttdt.subcontract.manage;; <Symbol Role="Message">Quit</Symbol> request.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->