<html>
<head>
<link href="mmres://user_interface_reference.css" rel="stylesheet" type="text/css">
<title>DELETECLIENTVARIABLE</title>
</head>
<body bgcolor="#FFFFFF" text="#000000">
   <div id="Description">
   <table cellpadding="0" cellspacing="0" border="0" width="100%" class="main">
      <tr> 
         <td valign="top" class="name">DELETECLIENTVARIABLE</td>
         <td valign="top" nowrap class="compatibility">&nbsp;</td>
      </tr>
      <tr>
         <td colspan="2" class="divider"><img src="dwres:18084" width="100%" height="1"></td>
      </tr>


    </td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="description"><span class="title">Description</span>
<p>
Deletes a client variable. (To test for the existence of a variable, use IsDefined.)
</p>
    </td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="CLEARSEPARATION">&nbsp;</td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="description"><span class="title">Returns</span>
<p>
True, if the variable is successfully deleted; false, otherwise. 
</p>
    </td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="CLEARSEPARATION">&nbsp;</td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="description"><span class="title">Category</span>
<p>
Other functions
</p>
    </td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="CLEARSEPARATION">&nbsp;</td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="description"><span class="title">Function syntax</span><pre>DeleteClientVariable(&quot;name&quot;)
</pre>    </td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="CLEARSEPARATION">&nbsp;</td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="description"><span class="title">See also</span>
<p>
GetClientVariablesList
</p>
    </td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="CLEARSEPARATION">&nbsp;</td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="description"><span class="title">History</span>
<p>
ColdFusion&#160;MX: Changed behavior: if the variable is not present, this function now returns False. (In earlier releases, it threw an error.)
</p>
    </td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="CLEARSEPARATION">&nbsp;</td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="description"><span class="title">Parameters</span>
<p>

</p>
    </td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="CLEARSEPARATION">&nbsp;</td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="description"><span class="title">Example</span><pre>&lt;!--- This view-only example shows DeleteClientVariable ---&gt;
&lt;h3&gt;DeleteClientVariable Example&lt;/h3&gt;

&lt;p&gt;This view-only example deletes a client variable called &quot;User_ID&quot;, if it 
   exists in the list of client variables returned by GetClientVariablesList.
&lt;p&gt;This example requires the existence of an Application.cfm file and client
   management to be in effect.
&lt;!--- 
&lt;cfset client.somevar = &quot;&quot;&gt;
&lt;cfset client.user_id = &quot;&quot;&gt;
&lt;p&gt;Client variable list:&lt;cfoutput&gt;#GetClientVariablesList()#&lt;/cfoutput&gt;
&lt;cfif ListFindNoCase(GetClientVariablesList(), &quot;User_ID&quot;) is not 0&gt;

      &lt;cfset temp = DeleteClientVariable(&quot;User_ID&quot;)&gt;
      &lt;p&gt;Was variable &quot;User_ID&quot; Deleted? &lt;cfoutput&gt;#temp#&lt;/cfoutput&gt;
&lt;/cfif&gt;
&lt;p&gt;Amended Client variable list:&lt;cfoutput&gt;#GetClientVariablesList()#
&lt;/cfoutput&gt;
---&gt;
</pre>
         </td>
      </tr>
   </table>
   </div>
<div id="NAME">
<table border="0" cellspacing="0" cellpadding="0" width="100%">
<tr>  
<td valign="top" class="name">NAME</td>
  <td valign="top" nowrap class="compatibility">&nbsp;</td>
  </tr>
  <tr>
  <td colspan="2" class="divider"><img src="dwres:18084" width="100%" height="1"></td>
  </tr>


<p>Name of a client variable to delete, surrounded by double-quotation marks</p>

  </td>
  </tr>
  </table>
</div>

  </body>
</html>
