Helix SwarmHelix Swarm

P4API.P4Form.html

  • //
  • guest/
  • rjnilsson/
  • P4.Net/
  • MAIN/
  • doc/
  • html/
  • P4API.P4Form.html #1
  • View
  • Commits
  • Open Download .zip Download (4 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>P4Form Class</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">P4Form Class</h1>
  21. </div>
  22. </div>
  23.     <div id="nstext">
  24.       <p> Represents a Perforce 'Form' object. </p>
  25.       <p>For a list of all members of this type, see <a href="P4API.P4FormMembers.html">P4Form Members</a>.</p>
  26.       <p>
  27.         <a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemObjectClassTopic.htm">System.Object</a>
  28.         <br /><a href="P4API.P4Record.html">P4API.P4Record</a><br /><b>P4API.P4Form</b></p>
  29.       <div class="syntax">
  30.         <span class="lang">[VisualBasic]</span>
  31.         <br />PublicClassP4Form<div>Inherits<a href="P4API.P4Record.html">P4Record</a></div></div>
  32.       <div class="syntax">
  33.         <span class="lang">[C#]</span>
  34.         <div>publicclassP4Form<b> : <a href="P4API.P4Record.html">P4Record</a></b></div>
  35.       </div>
  36.       <h4 class="dtH4">Remarks</h4>
  37.       <p> Forms are the things that pop-up in an editor when run from a command line. In P4.Net (and most other Perforce APIs), you do not need to parse/format the text manually. Instead, you can get/set the fields using the Fields and ArrayFields collections. <P>The following is a list of common form commands:</P>
  38.         <list>
  39.           <li>client</li>
  40.           <li>branch</li>
  41.           <li>label</li>
  42.           <li>job</li>
  43.           <li>user</li>
  44.           <li>group</li>
  45.           <li>protect</li>
  46.           <li>triggers</li>
  47.           <li>branch</li>
  48.         </list>
  49.         <P> When fetching or saving a form, <B>do not use the '-o' and '-i' flags</B>. P4.Net will automatically include them. </P>
  50.       </p>
  51.       <h4 class="dtH4">Example</h4>
  52.       <p> The following example updates the current client. It changes the client root, and adds a line to the view. <pre class="code" language="C#" escaped="true">          P4Connection p4 = new P4Connection();
  53.           p4.Connect();
  54.  
  55.           P4Form MyClient = p4.Fetch_Form("client");
  56.  
  57.           //Change the root and properties
  58.           MyClient["Root"] = @"C:\p4\P4.NetClient";
  59.           MyClient["Description"] = "Created from P4.Net!";
  60.  
  61.           //Fetch the clientName (for use later in building the view spec).
  62.           string clientName = MyClient["Client"];
  63.  
  64.           // Build a new array, that has one more element than the current view
  65.           string[] NewView = new string[MyClient.ArrayFields["View"].Length + 1];
  66.  
  67.           // Copy the existing view lines to the new array
  68.           MyClient.ArrayFields["View"].CopyTo(NewView,0);
  69.  
  70.           // Set the new view line
  71.           NewView[NewView.Length - 1] = string.Format("//depot/newpath/... //{0}/newpath/...", clientName);
  72.  
  73.           MyClient.ArrayFields["View"] = NewView;
  74.  
  75.           // Save the form
  76.           P4UnParsedRecordSet MyResult = p4.Save_Form(MyClient);
  77.           p4.Disconnect();
  78.         </pre>
  79.       </p>
  80.       <h4 class="dtH4">Requirements</h4>
  81.       <p>
  82.         <b>Namespace: </b>
  83.         <a href="P4API.html">P4API</a>
  84.       </p>
  85.       <p>
  86.         <b>Assembly: </b>p4api (in p4api.dll)
  87. 					</p>
  88.       <h4 class="dtH4">See Also</h4>
  89.       <p>
  90.         <a href="P4API.P4FormMembers.html">P4Form Members</a> | <a href="P4API.html">P4API Namespace</a></p>
  91.       <object type="application/x-oleobject" classid="clsid:1e2a7bd0-dab9-11d0-b93a-00c04fc99f9e" viewastext="true" style="display: none;">
  92.         <param name="Keyword" value="P4Form class, about P4Form class">
  93.         </param>
  94.       </object>
  95.       <hr />
  96.       <div id="footer">
  97.         <p>
  98.           <a href="Copyright.html">Copyright  2006 Shawn Hladky</a>
  99.         </p>
  100.         <p>
  101.         </p>
  102.       </div>
  103.     </div>
  104.   </body>
  105. </html>
# Change User Description Committed
#1 7889 Johan Nilsson Branch from Shawn Hladky's original P4.Net (main branch).
Changed file type for StandardT...est.cs and UnicodeTest.cs in order to be able to check them in. «		 14 years ago
//guest/shawn_hladky/P4.Net/main/doc/html/P4API.P4Form.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.P4Form.html
#2 5825 Shawn Hladky P4.Net: Binaries and compiled docs for 0.9 18 years ago
#1 5812 Shawn Hladky P4.Net: More documentation. 18 years ago