<!-- $XConsortium: h_arg_mo.sgm /main/5 1996/08/30 14:35:08 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.MAN171.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN171.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_otype_hsig_arg_mode</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_otype_hsig_arg_mode</Function></RefName>
<RefPurpose>return the mode of an argument of a request signature of an otype
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: h_arg_mo.sgm /main/5 1996/08/30 14:35:08 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/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>Tt_mode <Function>tt_otype_hsig_arg_mode</Function></FuncDef>
<ParamDef>const char *<Parameter>otype</Parameter></ParamDef>
<ParamDef>int <Parameter>sig</Parameter></ParamDef>
<ParamDef>int <Parameter>arg</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_otype_hsig_arg_mode</Function> function
returns the mode of the
<Emphasis>arg</Emphasis>th argument of the
<Emphasis>sig</Emphasis>th request signature of
the given
otype.
</Para>
<Para>The
<Emphasis>otype</Emphasis> argument is the object type involved in this operation.
The
<Emphasis>sig</Emphasis> argument is the zero-based index into the request signatures
of the specified
otype.
The
<Emphasis>arg</Emphasis> argument is the zero-based index into the arguments of the specified signature.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_otype_hsig_arg_mode</Function> function returns a value that determines who
(sender or handler) writes and reads a message argument.
The following modes are defined:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_IN</Term>
<ListItem>
<Para>The argument is written by the sender and read by the
handler and any observers.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_OUT</Term>
<ListItem>
<Para>The argument is written by the handler and read by the
sender and any reply observers.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_INOUT</Term>
<ListItem>
<Para>The argument is written by the sender and the
handler and read by all.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The application can use
&cdeman.tt.int.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the
<StructName Role="typedef">Tt_mode</StructName> integer return value:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_OK</Term>
<ListItem>
<Para>The operation completed successfully.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_NOMP</Term>
<ListItem>
<Para>The
&cdeman.ttsession; process is not running and the ToolTalk service cannot restart it.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_NUM</Term>
<ListItem>
<Para>The integer value passed was invalid (out of range).
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_OTYPE</Term>
<ListItem>
<Para>The specified object type is not the name of an installed object type.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.otype.hsig.arg.type;, &cdeman.tt.otype.hsig.count;, &cdeman.tt.otype.hsig.args.count;, &cdeman.tt.otype.hsig.op;, &cdeman.tt.int.error;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
