Helix SwarmHelix Swarm

P4API.P4Connection.IsValidConnection.html

  • //
  • guest/
  • MikeEheler/
  • P4.Net/
  • main/
  • doc/
  • html/
  • P4API.P4Connection.IsValidConnection.html #1
  • View
  • Commits
  • Open Download .zip Download (3 KB) 
  1. <html dir="LTR">
  2.   <head>
  3.     <meta http-equiv="Content-Type" content="text/html; charset=Windows-1252" />
  4.     <meta name="vs_targetSchema" content="http://schemas.microsoft.com/intellisense/ie5" />
  5.     <title>P4Connection.IsValidConnection Method</title>
  6.     <xml>
  7.     </xml>
  8.     <link rel="stylesheet" type="text/css" href="MSDN.css" />
  9.   </head>
  10.   <body id="bodyID" class="dtBODY">
  11.     <div id="nsbanner">	<div id="bannerrow1">
  12. 		<table class="bannerparthead" cellspacing="0" id="Table1">
  13. 			<tr id="hdr">
  14. 				<td class="runninghead">Perforce API for the .Net CLR</td>
  15. 				<td class="product"><img alt="P4.Net" src="p4net.GIF" /></td>
  16. 			</tr>
  17. 		</table>
  18. 	</div>
  19. 	<div id="TitleRow">
  20. 		<h1 class="dtH1">P4Connection.IsValidConnectionMethod</h1>
  21. </div>
  22. </div>
  23.     <div id="nstext">
  24.       <p> Determines if the Perforce connection is valid. </p>
  25.       <div class="syntax">
  26.         <span class="lang">[VisualBasic]</span>
  27.         <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>
  28.       <div class="syntax">
  29.         <span class="lang">[C#]</span>
  30.         <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>
  31.       <h4 class="dtH4">Parameters</h4>
  32.       <dl>
  33.         <dt>
  34.           <i>checkLogin</i>
  35.         </dt>
  36.         <dd>if set to <code>true</code> it will check if the user is logged in.</dd>
  37.         <dt>
  38.           <i>checkClient</i>
  39.         </dt>
  40.         <dd>if set to <code>true</code> it will verify the client exists.</dd>
  41.       </dl>
  42.       <h4 class="dtH4">Return Value</h4>
  43.       <p>
  44.             	<code>true</code> if the connection is valid; otherwise, <code>false</code>. </p>
  45.       <h4 class="dtH4">Remarks</h4>
  46.       <p> IsValidConnection performs the following 3 checks (depending on the arguments passed). <list type="numbered">
  47.             <li>Runs p4 info, and verifies the server is valid.</li>
  48.             <li>If checkClient is true, verifies that p4 info returns a clientName that is not "*unknown*.</li>
  49.             <li>If checkLogin is true, verifies that p4 login -s does not have errors.</li>
  50.             </list>
  51.             </p>
  52.       <h4 class="dtH4">See Also</h4>
  53.       <p>
  54.         <a href="P4API.P4Connection.html">P4Connection Class</a> | <a href="P4API.html">P4API Namespace</a></p>
  55.       <object type="application/x-oleobject" classid="clsid:1e2a7bd0-dab9-11d0-b93a-00c04fc99f9e" viewastext="true" style="display: none;">
  56.         <param name="Keyword" value="IsValidConnection method">
  57.         </param>
  58.         <param name="Keyword" value="IsValidConnection method, P4Connection class">
  59.         </param>
  60.         <param name="Keyword" value="P4Connection.IsValidConnection method">
  61.         </param>
  62.       </object>
  63.       <hr />
  64.       <div id="footer">
  65.         <p>
  66.           <a href="Copyright.html">Copyright  2006 Shawn Hladky</a>
  67.         </p>
  68.         <p>
  69.         </p>
  70.       </div>
  71.     </div>
  72.   </body>
  73. </html>
# Change User Description Committed
#1 19706 MikeEheler Populate //guest/shawn_hladky/P4.Net/...
//guest/MikeEheler/P4.Net/.... 		9 years ago
//guest/shawn_hladky/P4.Net/main/doc/html/P4API.P4Connection.IsValidConnection.html
#3 7709 Shawn Hladky P4.Net:  Cleanup, documentation, and a a start for implementing an object-based outpu...t for filelog. « 15 years ago
#2 6105 Shawn Hladky P4.Net: Updating documentation output to sandcastle. 17 years ago
#1 5830 Shawn Hladky P4.Net: reorg to support release branches 18 years ago
//guest/shawn_hladky/P4.Net/doc/html/P4API.P4Connection.IsValidConnection.html
#1 5812 Shawn Hladky P4.Net: More documentation. 18 years ago