carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/reference/api/com/nokia/carbide/cdt/builder/project/IEnvironmentVarsInfo.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_15) on Tue Jan 06 17:31:53 CST 2009 -->
<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<TITLE>
IEnvironmentVarsInfo (Carbide.c++ SDK API Reference)
</TITLE>
<META NAME="keywords" CONTENT="com.nokia.carbide.cdt.builder.project.IEnvironmentVarsInfo interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IEnvironmentVarsInfo (Carbide.c++ SDK API Reference)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IEnvironmentVarsInfo.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Carbide.c++</b></EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../com/nokia/carbide/cdt/builder/project/IEnvironmentVariable.html" title="interface in com.nokia.carbide.cdt.builder.project"><B>PREV CLASS</B></A>
<A HREF="../../../../../../com/nokia/carbide/cdt/builder/project/IROMBuilderInfo.html" title="interface in com.nokia.carbide.cdt.builder.project"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html?com/nokia/carbide/cdt/builder/project/IEnvironmentVarsInfo.html" target="_top"><B>FRAMES</B></A>
<A HREF="IEnvironmentVarsInfo.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.nokia.carbide.cdt.builder.project</FONT>
<BR>
Interface IEnvironmentVarsInfo</H2>
<HR>
<DL>
<DT><PRE>public interface <B>IEnvironmentVarsInfo</B></DL>
</PRE>
<P>
IEnvironmentVarsInfo represents the set of all environment variables for a given ICarbideBuildConfiguration object.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><CODE>IEnvironmentVariable, ICarbideBuildConfiguration</CODE></DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.List<<A HREF="../../../../../../com/nokia/carbide/cdt/builder/project/IEnvironmentVariable.html" title="interface in com.nokia.carbide.cdt.builder.project">IEnvironmentVariable</A>></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/nokia/carbide/cdt/builder/project/IEnvironmentVarsInfo.html#getDefaultEnvVarsList(com.nokia.carbide.cdt.builder.project.ICarbideProjectInfo, com.nokia.carbide.cpp.sdk.core.ISymbianBuildContext)">getDefaultEnvVarsList</A></B>(<A HREF="../../../../../../com/nokia/carbide/cdt/builder/project/ICarbideProjectInfo.html" title="interface in com.nokia.carbide.cdt.builder.project">ICarbideProjectInfo</A> carbideProject,
<A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/ISymbianBuildContext.html" title="interface in com.nokia.carbide.cpp.sdk.core">ISymbianBuildContext</A> context)</CODE>
<BR>
Get the list of list of environment variables that are modifed from default</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/nokia/carbide/cdt/builder/project/IEnvironmentVarsInfo.html#getDefaultEnvVarsSettings(com.nokia.carbide.cdt.builder.project.ICarbideProjectInfo, com.nokia.carbide.cpp.sdk.core.ISymbianBuildContext)">getDefaultEnvVarsSettings</A></B>(<A HREF="../../../../../../com/nokia/carbide/cdt/builder/project/ICarbideProjectInfo.html" title="interface in com.nokia.carbide.cdt.builder.project">ICarbideProjectInfo</A> carbideProject,
<A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/ISymbianBuildContext.html" title="interface in com.nokia.carbide.cpp.sdk.core">ISymbianBuildContext</A> context)</CODE>
<BR>
Get the list of environment variables for configuration/platform</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../../com/nokia/carbide/cdt/builder/project/IEnvironmentVariable.html" title="interface in com.nokia.carbide.cdt.builder.project">IEnvironmentVariable</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/nokia/carbide/cdt/builder/project/IEnvironmentVarsInfo.html#getEnvVarFromConfiguration(java.lang.String)">getEnvVarFromConfiguration</A></B>(java.lang.String varName)</CODE>
<BR>
Get an IEnvironmentVariable from the configuration from a variable name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/nokia/carbide/cdt/builder/project/IEnvironmentVarsInfo.html#getModifiedEnvironmentVariables()">getModifiedEnvironmentVariables</A></B>()</CODE>
<BR>
Get the array of variables (resolved) that differ from the default.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.List<<A HREF="../../../../../../com/nokia/carbide/cdt/builder/project/IEnvironmentVariable.html" title="interface in com.nokia.carbide.cdt.builder.project">IEnvironmentVariable</A>></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/nokia/carbide/cdt/builder/project/IEnvironmentVarsInfo.html#getModifiedEnvVarsListFromSettings()">getModifiedEnvVarsListFromSettings</A></B>()</CODE>
<BR>
Get the list of environment variables that are modified from their default value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/nokia/carbide/cdt/builder/project/IEnvironmentVarsInfo.html#getResolvedEnvironmentVariables()">getResolvedEnvironmentVariables</A></B>()</CODE>
<BR>
The fully resolved list of environment variables that can be used to build for a configuration.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/nokia/carbide/cdt/builder/project/IEnvironmentVarsInfo.html#setModifiedEnvVarsList(java.util.List)">setModifiedEnvVarsList</A></B>(java.util.List<<A HREF="../../../../../../com/nokia/carbide/cdt/builder/project/IEnvironmentVariable.html" title="interface in com.nokia.carbide.cdt.builder.project">IEnvironmentVariable</A>> envVarsList)</CODE>
<BR>
Update the entire variable list, which upates the interface to the DOM as well</TD>
</TR>
</TABLE>
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getModifiedEnvVarsListFromSettings()"><!-- --></A><H3>
getModifiedEnvVarsListFromSettings</H3>
<PRE>
java.util.List<<A HREF="../../../../../../com/nokia/carbide/cdt/builder/project/IEnvironmentVariable.html" title="interface in com.nokia.carbide.cdt.builder.project">IEnvironmentVariable</A>> <B>getModifiedEnvVarsListFromSettings</B>()</PRE>
<DL>
<DD>Get the list of environment variables that are modified from their default value.
This ONLY returns the list of variables that are stored in the configuraiton settings
that differ from the default values
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The list of modified environment variables</DL>
</DD>
</DL>
<HR>
<A NAME="setModifiedEnvVarsList(java.util.List)"><!-- --></A><H3>
setModifiedEnvVarsList</H3>
<PRE>
void <B>setModifiedEnvVarsList</B>(java.util.List<<A HREF="../../../../../../com/nokia/carbide/cdt/builder/project/IEnvironmentVariable.html" title="interface in com.nokia.carbide.cdt.builder.project">IEnvironmentVariable</A>> envVarsList)</PRE>
<DL>
<DD>Update the entire variable list, which upates the interface to the DOM as well
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getResolvedEnvironmentVariables()"><!-- --></A><H3>
getResolvedEnvironmentVariables</H3>
<PRE>
java.lang.String[] <B>getResolvedEnvironmentVariables</B>()</PRE>
<DL>
<DD>The fully resolved list of environment variables that can be used to build for a configuration.
Use this to construct a full environment for a particular configuraiton's process invocation
<P>
<DD><DL>
<DT><B>Returns:</B><DD>A String array of environment variables of form <var>=<value></DL>
</DD>
</DL>
<HR>
<A NAME="getModifiedEnvironmentVariables()"><!-- --></A><H3>
getModifiedEnvironmentVariables</H3>
<PRE>
java.lang.String[] <B>getModifiedEnvironmentVariables</B>()</PRE>
<DL>
<DD>Get the array of variables (resolved) that differ from the default. This includes both
those modified in the settings and those that Carbide implicity modifies such as EPOCROOT and PATH
<P>
<DD><DL>
<DT><B>Returns:</B><DD>An array of string values that differ from original of form <var>=<value></DL>
</DD>
</DL>
<HR>
<A NAME="getDefaultEnvVarsSettings(com.nokia.carbide.cdt.builder.project.ICarbideProjectInfo, com.nokia.carbide.cpp.sdk.core.ISymbianBuildContext)"><!-- --></A><H3>
getDefaultEnvVarsSettings</H3>
<PRE>
java.lang.String[] <B>getDefaultEnvVarsSettings</B>(<A HREF="../../../../../../com/nokia/carbide/cdt/builder/project/ICarbideProjectInfo.html" title="interface in com.nokia.carbide.cdt.builder.project">ICarbideProjectInfo</A> carbideProject,
<A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/ISymbianBuildContext.html" title="interface in com.nokia.carbide.cpp.sdk.core">ISymbianBuildContext</A> context)</PRE>
<DL>
<DD>Get the list of environment variables for configuration/platform
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>carbideProject</CODE> - - The current project<DD><CODE>context</CODE> - - The current context to get the vars for.
<DT><B>Returns:</B><DD>An array a resolved environment variables of format <var>=<value>.</DL>
</DD>
</DL>
<HR>
<A NAME="getDefaultEnvVarsList(com.nokia.carbide.cdt.builder.project.ICarbideProjectInfo, com.nokia.carbide.cpp.sdk.core.ISymbianBuildContext)"><!-- --></A><H3>
getDefaultEnvVarsList</H3>
<PRE>
java.util.List<<A HREF="../../../../../../com/nokia/carbide/cdt/builder/project/IEnvironmentVariable.html" title="interface in com.nokia.carbide.cdt.builder.project">IEnvironmentVariable</A>> <B>getDefaultEnvVarsList</B>(<A HREF="../../../../../../com/nokia/carbide/cdt/builder/project/ICarbideProjectInfo.html" title="interface in com.nokia.carbide.cdt.builder.project">ICarbideProjectInfo</A> carbideProject,
<A HREF="../../../../../../com/nokia/carbide/cpp/sdk/core/ISymbianBuildContext.html" title="interface in com.nokia.carbide.cpp.sdk.core">ISymbianBuildContext</A> context)</PRE>
<DL>
<DD>Get the list of list of environment variables that are modifed from default
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>carbideProject</CODE> - - current carbide project<DD><CODE>context</CODE> - - platform we are building for
<DT><B>Returns:</B><DD>- The list of modified variables that are created as defaults.</DL>
</DD>
</DL>
<HR>
<A NAME="getEnvVarFromConfiguration(java.lang.String)"><!-- --></A><H3>
getEnvVarFromConfiguration</H3>
<PRE>
<A HREF="../../../../../../com/nokia/carbide/cdt/builder/project/IEnvironmentVariable.html" title="interface in com.nokia.carbide.cdt.builder.project">IEnvironmentVariable</A> <B>getEnvVarFromConfiguration</B>(java.lang.String varName)</PRE>
<DL>
<DD>Get an IEnvironmentVariable from the configuration from a variable name. This is only Win32 OS specific
so variable name checks are case insensitive. Only variables that have overrides from the default environment
value are returned.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>varName</CODE> - - The variable name to check to see if overridden.
<DT><B>Returns:</B><DD>IEnvironmentVariable, if defined in the configuration, otherwise null meaning that the default is used.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IEnvironmentVarsInfo.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Carbide.c++</b></EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../com/nokia/carbide/cdt/builder/project/IEnvironmentVariable.html" title="interface in com.nokia.carbide.cdt.builder.project"><B>PREV CLASS</B></A>
<A HREF="../../../../../../com/nokia/carbide/cdt/builder/project/IROMBuilderInfo.html" title="interface in com.nokia.carbide.cdt.builder.project"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html?com/nokia/carbide/cdt/builder/project/IEnvironmentVarsInfo.html" target="_top"><B>FRAMES</B></A>
<A HREF="IEnvironmentVarsInfo.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<div id="footer">Copyright © 2010 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. <br>License: <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a></div>
</BODY>
</HTML>