115 lines
4.3 KiB
Plaintext
115 lines
4.3 KiB
Plaintext
<!-- $XConsortium: fil_netf.sgm /main/7 1996/09/08 20:12: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.MAN74.rsml.1">]]>
|
|
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN74.rsml.1">]]>
|
|
<RefMeta>
|
|
<RefEntryTitle>tt_file_netfile</RefEntryTitle>
|
|
<ManVolNum>library call</ManVolNum>
|
|
</RefMeta>
|
|
<RefNameDiv>
|
|
<RefName><Function>tt_file_netfile</Function></RefName>
|
|
<RefPurpose>map between local and canonical pathnames on the local host
|
|
</RefPurpose>
|
|
</RefNameDiv>
|
|
<!-- $XConsortium: fil_netf.sgm /main/7 1996/09/08 20:12: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 <Tt/tt_c.h>
|
|
</FuncSynopsisInfo>
|
|
<FuncDef>char <Function>*tt_file_netfile</Function></FuncDef>
|
|
<ParamDef>const char *<Parameter>filename</Parameter></ParamDef>
|
|
</FuncSynopsis>
|
|
</RefSynopsisDiv>
|
|
<RefSect1>
|
|
<Title>DESCRIPTION</Title>
|
|
<Para>The
|
|
<Function>tt_file_netfile</Function> function converts a local pathname to a
|
|
<Emphasis>netfilename</Emphasis>, a form that can be passed to other hosts on the network and converted
|
|
back to a local pathname for the same file with
|
|
&cdeman.tt.netfile.file;.</Para>
|
|
<Para>The
|
|
<Symbol Role="Variable">filename</Symbol> argument is
|
|
a pathname (absolute or relative) that is valid on the local host.
|
|
Every component of
|
|
<Symbol Role="Variable">filename</Symbol> must exist, except that the last component need not exist.
|
|
</Para>
|
|
</RefSect1>
|
|
<RefSect1>
|
|
<Title>RETURN VALUE</Title>
|
|
<Para>Upon successful completion, the
|
|
<Function>tt_file_netfile</Function> function returns
|
|
a freshly allocated
|
|
null-terminated string of unspecified format, which can be passed to
|
|
&cdeman.tt.netfile.file; or
|
|
&cdeman.tt.host.netfile.file;; otherwise, it returns an error pointer.
|
|
The application can use
|
|
&cdeman.tt.ptr.error; to extract one of the following
|
|
<StructName Role="typedef">Tt_status</StructName> values from the returned pointer:
|
|
</Para>
|
|
<VariableList>
|
|
<VarListEntry>
|
|
<Term>TT_ERR_PATH</Term>
|
|
<ListItem>
|
|
<Para>The
|
|
<Symbol Role="Variable">filename</Symbol> argument is a path that is not valid on this host.
|
|
</Para>
|
|
</ListItem>
|
|
</VarListEntry>
|
|
</VariableList>
|
|
</RefSect1>
|
|
<RefSect1>
|
|
<Title>APPLICATION USAGE</Title>
|
|
<Para>The
|
|
&cdeman.tt.file.netfile;, &cdeman.tt.netfile.file;, &cdeman.tt.host.file.netfile; and
|
|
&cdeman.tt.host.netfile.file; functions allow an
|
|
application to determine a path valid on remote hosts,
|
|
perhaps for purposes of constructing a command string valid for remote
|
|
execution on that host.
|
|
By composing the two calls, paths for files not accessible from the
|
|
current host can be constructed.
|
|
For example, if path
|
|
<Filename>/sample/file</Filename> is valid on host A, a program
|
|
running on host B can use
|
|
</Para>
|
|
<InformalExample Remap="indent">
|
|
<ProgramListing>tt_host_netfile_file("C", tt_host_file_netfile("A", "/sample/file"))
|
|
</ProgramListing>
|
|
</InformalExample>
|
|
<Para>to determine a path to the same file valid on host C, if such a
|
|
path is possible.
|
|
</Para>
|
|
<Para>The
|
|
<Emphasis>netfile</Emphasis> string
|
|
returned by
|
|
<Function>tt_file_netfile</Function> should be considered opaque;
|
|
the content and format of the strings are not a public interface.
|
|
These strings can be safely copied (with
|
|
<Function>strcpy</Function>3C or similar methods), written to files, or transmitted
|
|
to other processes, perhaps on other hosts.
|
|
</Para>
|
|
<Para>Allocated strings should be freed using either
|
|
&cdeman.tt.free; or
|
|
&cdeman.tt.release;.</Para>
|
|
<Para>The
|
|
&cdeman.tt.open; function need not be called before
|
|
<Function>tt_file_netfile</Function>.</Para>
|
|
</RefSect1>
|
|
<RefSect1>
|
|
<Title>SEE ALSO</Title>
|
|
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.netfile.file;, &cdeman.tt.host.file.netfile;, &cdeman.tt.host.netfile.file;, &cdeman.tt.open;, &cdeman.tt.free;, &cdeman.tt.release;.</Para>
|
|
</RefSect1>
|
|
</RefEntry>
|
|
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|