Files
cdesktop/cde/doc/C/guides/man/m3_tt/pr_sess.sgm

101 lines
2.7 KiB
Plaintext

<!-- $XConsortium: pr_sess.sgm /main/9 1996/09/08 20:13:18 rws $ -->
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
<!-- (c) Copyright 1996 International Business Machines Corp. -->
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1996 Novell, Inc. -->
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
<!-- (c) Copyright 1996 Hitachi. -->
<![%CDE.C.CDE;[<Refentry Id="CDEMX.XCDI.MAN215a.rsml.1">]]>
<![%CDE.C.XO;[<Refentry Id="XCDI.MAN215a.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_procid_session</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_procid_session</Function></RefName>
<RefPurpose>
identify the session in which a procid was opened
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>const char *<Function>tt_procid_session</Function></FuncDef>
<ParamDef>const char *<Parameter>procid</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_procid_session</Function> function
returns the identifier of the session in which the
specified procid was opened.
</para>
<para>The return value points to the sessid for the session associated with
the procid. When the sessid value is no longer needed, it
must be freed with <function>tt_free</function>.
</para>
</RefSect1>
<RefSect1>
<Title>ARGUMENTS</Title>
<VariableList>
<VarListEntry>
<Term><symbol role="Variable">procid</symbol></Term>
<ListItem>
<Para>The identifier for the procid for which the session
identifier is to be returned.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_procid_session</Function> function returns
the pointer to the session identifier.
</Para>
<VariableList>
<VarListEntry>
<Term><systemitem class="constant">TT_OK</systemitem></Term>
<ListItem>
<Para>The operation completed successfully.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><systemitem class="constant">TT_ERR_NOMP</systemitem></Term>
<ListItem>
<Para>The <command>ttsession</command> process is not running
and the ToolTalk service cannot restart it.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><systemitem class="constant">TT_ERR_PROCID</systemitem></Term>
<ListItem>
<Para>The specified process identifier is out of date or invalid.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;,
&cdeman.tt.free;,
&cdeman.tt.error.pointer;
</Para>
</RefSect1>
</refentry>