P4API.P4Connection.IsValidConnection.html #1 

<html dir="LTR">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=Windows-1252" />
    <meta name="vs_targetSchema" content="http://schemas.microsoft.com/intellisense/ie5" />
    <title>P4Connection.IsValidConnection Method</title>
    <xml>
    </xml>
    <link rel="stylesheet" type="text/css" href="MSDN.css" />
  </head>
  <body id="bodyID" class="dtBODY">
    <div id="nsbanner">	<div id="bannerrow1">
		<table class="bannerparthead" cellspacing="0" id="Table1">
			<tr id="hdr">
				<td class="runninghead">Perforce API for the .Net CLR</td>
				<td class="product"><img alt="P4.Net" src="p4net.GIF" /></td>
			</tr>
		</table>
	</div>
	<div id="TitleRow">
		<h1 class="dtH1">P4Connection.IsValidConnectionMethod</h1>
</div>
</div>
    <div id="nstext">
      <p> Determines if the Perforce connection is valid. </p>
      <div class="syntax">
        <span class="lang">[VisualBasic]</span>
        <br />PublicFunctionIsValidConnection( _<br />ByVal <i>checkLogin</i>As<a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemBooleanClassTopic.htm">Boolean</a>,_<br />ByVal <i>checkClient</i>As<a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemBooleanClassTopic.htm">Boolean</a>_<br />)As<a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemBooleanClassTopic.htm">Boolean</a></div>
      <div class="syntax">
        <span class="lang">[C#]</span>
        <br />public<a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemBooleanClassTopic.htm">bool</a>IsValidConnection(<br /><a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemBooleanClassTopic.htm">bool</a><i>checkLogin</i>,<br /><a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemBooleanClassTopic.htm">bool</a><i>checkClient</i><br />);</div>
      <h4 class="dtH4">Parameters</h4>
      <dl>
        <dt>
          <i>checkLogin</i>
        </dt>
        <dd>if set to <code>true</code> it will check if the user is logged in.</dd>
        <dt>
          <i>checkClient</i>
        </dt>
        <dd>if set to <code>true</code> it will verify the client exists.</dd>
      </dl>
      <h4 class="dtH4">Return Value</h4>
      <p>
            	<code>true</code> if the connection is valid; otherwise, <code>false</code>. </p>
      <h4 class="dtH4">Remarks</h4>
      <p> IsValidConnection performs the following 3 checks (depending on the arguments passed). <list type="numbered">
            <li>Runs p4 info, and verifies the server is valid.</li>
            <li>If checkClient is true, verifies that p4 info returns a clientName that is not "*unknown*.</li>
            <li>If checkLogin is true, verifies that p4 login -s does not have errors.</li>
            </list>
            </p>
      <h4 class="dtH4">See Also</h4>
      <p>
        <a href="P4API.P4Connection.html">P4Connection Class</a> | <a href="P4API.html">P4API Namespace</a></p>
      <object type="application/x-oleobject" classid="clsid:1e2a7bd0-dab9-11d0-b93a-00c04fc99f9e" viewastext="true" style="display: none;">
        <param name="Keyword" value="IsValidConnection method">
        </param>
        <param name="Keyword" value="IsValidConnection method, P4Connection class">
        </param>
        <param name="Keyword" value="P4Connection.IsValidConnection method">
        </param>
      </object>
      <hr />
      <div id="footer">
        <p>
          <a href="Copyright.html">Copyright  2006 Shawn Hladky</a>
        </p>
        <p>
        </p>
      </div>
    </div>
  </body>
</html>
# Change User Description Committed
#1 5831 Shawn Hladky P4.Net: Branch release 0.9 and delete a few files missed last time
//guest/shawn_hladky/P4.Net/main/doc/html/P4API.P4Connection.IsValidConnection.html
#1 5830 Shawn Hladky P4.Net: reorg to support release branches
//guest/shawn_hladky/P4.Net/doc/html/P4API.P4Connection.IsValidConnection.html
#1 5812 Shawn Hladky P4.Net: More documentation.