Initial import of the CDE 2.1.30 sources from the Open Group.
[oweals/cde.git] / cde / doc / C / guides / man / m3_tt_message / uid.sgm
1 <!-- $XConsortium: uid.sgm /main/5 1996/08/30 13:45:57 rws $ -->
2 <!-- (c) Copyright 1995 Digital Equipment Corporation. -->
3 <!-- (c) Copyright 1995 Hewlett-Packard Company. -->
4 <!-- (c) Copyright 1995 International Business Machines Corp. -->
5 <!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
6 <!-- (c) Copyright 1995 Novell, Inc. -->
7 <!-- (c) Copyright 1995 FUJITSU LIMITED. -->
8 <!-- (c) Copyright 1995 Hitachi. -->
9
10 <![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN156.rsml.1">]]>
11 <![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN156.rsml.1">]]>
12 <RefMeta>
13 <RefEntryTitle>tt_message_uid</RefEntryTitle>
14 <ManVolNum>library call</ManVolNum>
15 </RefMeta>
16 <RefNameDiv>
17 <RefName><Function>tt_message_uid</Function></RefName>
18 <RefPurpose>retrieve the user identifier attribute from a message
19 </RefPurpose>
20 </RefNameDiv>
21 <!-- $XConsortium: uid.sgm /main/5 1996/08/30 13:45:57 rws $-->
22 <!-- CDE Common Source Format, Version 1.0.0-->
23 <!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
24 <!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
25 <!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
26 <!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
27 <RefSynopsisDiv>
28 <FuncSynopsis Remap="ANSI">
29 <FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
30 </FuncSynopsisInfo>
31 <FuncDef>uid_t <Function>tt_message_uid</Function></FuncDef>
32 <ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
33 </FuncSynopsis>
34 </RefSynopsisDiv>
35 <RefSect1>
36 <Title>DESCRIPTION</Title>
37 <Para>The
38 <Function>tt_message_uid</Function> function
39 retrieves the user identifier attribute from the specified message.
40 </Para>
41 <Para>The ToolTalk service automatically sets the user identifier of a message with
42 the user identifier of the process that created the message.
43 </Para>
44 <Para>The
45 <Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
46 </Para>
47 </RefSect1>
48 <RefSect1>
49 <Title>RETURN VALUE</Title>
50 <Para>Upon successful completion, the
51 <Function>tt_message_uid</Function> function returns
52 the user identifier of the message.
53 If the group
54 <Literal>nobody</Literal> is returned, the
55 message handle is not valid.
56 </Para>
57 </RefSect1>
58 <RefSect1>
59 <Title>SEE ALSO</Title>
60 <Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.message.gid;.</Para>
61 </RefSect1>
62 </RefEntry>
63 <!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->