<!-- $XConsortium: Get_Env.sgm /main/5 1996/08/30 14:47:56 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.MAN285.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN285.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Get_Environment</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Get_Environment</Symbol></RefName>
<RefPurpose>get a tool's environment
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Get_Env.sgm /main/5 1996/08/30 14:47:56 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>
<Synopsis>Get_Environment(in string <Symbol Role="Variable">variable</Symbol>,
        out string <Symbol Role="Variable">value</Symbol>
        [...]);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Get_Environment</Symbol> request
reports the value of the indicated environment variable(s).
</Para>
<Para>The
<Symbol Role="Variable">variable</Symbol> argument
is the name of the environment variable to get.
</Para>
<Para>The
<Symbol Role="Variable">value</Symbol> argument
is the value of the environment variable.
If no value (in other words,
<Literal>(char *)0</Literal>) is returned for this
argument, then the variable was not present in the
handler's environment.
This condition is not an error.
If an empty string (in other words, "")
is returned for this argument, then the variable was present in the
handler's environment, but had a null value.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.session.join;, function can be used to register for,
and transparently process, the
<Symbol Role="Message">Get_Environment</Symbol> request.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.ttdt.session.join;; <Symbol Role="Message">Set_Environment</Symbol> request.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
