<!-- $XConsortium: op_str.sgm /main/5 1996/08/30 14:05:34 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.MAN280.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN280.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tttk_op_string</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tttk_op_string</Function></RefName>
<RefPurpose>map a ToolTalk op code to a string
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: op_str.sgm /main/5 1996/08/30 14:05:34 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>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tttk.h>
</FuncSynopsisInfo>
<FuncDef>char <Function>*tttk_op_string</Function></FuncDef>
<ParamDef>Tttk_op <Parameter>opcode</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tttk_op_string</Function> function
returns a string containing the op for
<Emphasis>opcode</Emphasis>.</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tttk_op_string</Function> function returns a string that can be freed using
&cdeman.tt.free;; otherwise, it returns
<SystemItem Class="Constant">NULL</SystemItem>.</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The distinctions in the
<StructName Role="typedef">Tttk_op</StructName> enumerated type are for programmer convenience, and elements of
<StructName Role="typedef">Tttk_op</StructName> do not necessarily map one-to-one with op strings, since ToolTalk
allows ops to be overloaded.
For example,
<SystemItem Class="Constant">TTME_EDIT</SystemItem> and
<SystemItem Class="Constant">TTME_COMPOSE</SystemItem> are overloaded on the same op
(<Symbol Role="Message">Edit</Symbol>), and the messages
only vary by the
<StructName Role="typedef">Tt_mode</StructName> of the first argument.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tttk.h;, &cdeman.tt.message.op;, &cdeman.tt.free;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
