Files
cdesktop/cde/doc/C/guides/man/m3_ttdt/open.sgm

78 lines
2.8 KiB
Plaintext

<!-- $XConsortium: open.sgm /main/5 1996/08/30 14:30:24 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.MAN264.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN264.rsml.1">]]>
<RefMeta>
<RefEntryTitle>ttdt_open</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>ttdt_open</Function></RefName>
<RefPurpose>create a ToolTalk communication endpoint
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: open.sgm /main/5 1996/08/30 14:30:24 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>*ttdt_open</Function></FuncDef>
<ParamDef>int *<Parameter>ttfd</Parameter></ParamDef>
<ParamDef>const char *<Parameter>toolname</Parameter></ParamDef>
<ParamDef>const char *<Parameter>vendor</Parameter></ParamDef>
<ParamDef>const char *<Parameter>version</Parameter></ParamDef>
<ParamDef>int <Parameter>sendStarted</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>ttdt_open</Function> function calls
&cdeman.tt.open; and
&cdeman.tt.fd;. It associates
<Emphasis>toolname</Emphasis>, <Emphasis>vendor</Emphasis> and
<Symbol Role="Variable">version</Symbol> with the created
procid,
and initializes the new
procid's
default contexts from the process environment.
If
<Emphasis>sendStarted</Emphasis> is True,
<Function>ttdt_open</Function> sends a
<Symbol Role="Message">Started</Symbol> notice.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>ttdt_open</Function> function
returns the created
procid
in a string that can be freed with
<Function>tt_free</Function>; otherwise, the
<Function>ttdt_open</Function> function may return any of the errors returned by
&cdeman.tt.open; and
&cdeman.tt.fd;.</Para>
<Para>No errors are propagated if sending the
<Symbol Role="Message">Started</Symbol> notice fails.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tttk.h;, &cdeman.ttdt.close;, &cdeman.tt.open;, &cdeman.tt.fd;, &cdeman.tt.free;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->