Loading...
Helix SwarmHelix Swarm
Loading...

T_P4API_P4Form.htm

  • //
  • guest/
  • andrew_mcdonald/
  • P4.Net/
  • main/
  • doc/
  • html/
  • html/
  • T_P4API_P4Form.htm #1
  • View
  • Commits
  • Open Download .zip Download (12 KB) 
  1. <html xmlns:MSHelp="http://msdn.microsoft.com/mshelp" xmlns:mshelp="http://msdn.microsoft.com/mshelp" xmlns:ddue="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:msxsl="urn:schemas-microsoft-com:xslt"><head><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8" /><META NAME="save" CONTENT="history" /><title>P4Form Class</title><link rel="stylesheet" type="text/css" href="../styles/presentation.css" /><link rel="stylesheet" type="text/css" href="ms-help://Hx/HxRuntime/HxLink.css" /><script type="text/javascript" src="../scripts/EventUtilities.js"> </script><script type="text/javascript" src="../scripts/SplitScreen.js"> </script><script type="text/javascript" src="../scripts/Dropdown.js"> </script><script type="text/javascript" src="../scripts/script_loc.js"> </script><script type="text/javascript" src="../scripts/script_manifold.js"> </script><script type="text/javascript" src="../scripts/script_feedBack.js"> </script><script type="text/javascript" src="../scripts/CheckboxMenu.js"> </script><script type="text/javascript" src="../scripts/CommonUtilities.js"> </script><meta name="container" content="p4api" /><meta name="file" content="T_P4API_P4Form" /><meta name="guid" content="T_P4API_P4Form" /><xml><MSHelp:TOCTitle Title="P4Form Class" /><MSHelp:RLTitle Title="P4Form Class (P4API)" /><MSHelp:Attr Name="AssetID" Value="T:P4API.P4Form" /><MSHelp:Keyword Index="A" Term="T:P4API.P4Form" /><MSHelp:Keyword Index="A" Term="frlrfP4APIP4FormClassTopic" /><MSHelp:Keyword Index="K" Term="P4Form class" /><MSHelp:Keyword Index="K" Term="P4API.P4Form class" /><MSHelp:Keyword Index="K" Term="P4Form class, about P4Form class" /><MSHelp:Keyword Index="F" Term="P4Form" /><MSHelp:Keyword Index="F" Term="P4API.P4Form" /><MSHelp:Attr Name="HelpPriority" Value="2" /><MSHelp:Attr Name="APIType" Value="Managed" /><MSHelp:Attr Name="APILocation" Value="p4api.dll" /><MSHelp:Attr Name="APIName" Value="P4API.P4Form" /><MSHelp:Attr Name="DevLang" Value="CSharp" /><MSHelp:Attr Name="Locale" Value="en-us" /><MSHelp:Attr Name="TopicType" Value="kbSyntax" /><MSHelp:Attr Name="TopicType" Value="apiref" /><MSHelp:Attr Name="Abstract" Value="Represents a Perforce 'Form' object." /></xml><link type="text/css" rel="stylesheet" href="../styles/highlight.css" /><script type="text/javascript" src="../scripts/highlight.js"></script></head><body><input type="hidden" id="userDataCache" class="userDataStyle" /><input type="hidden" id="hiddenScrollOffset" /><img id="collapseImage" style="display:none; height:0; width:0;" src="../icons/collapse_all.gif" title="Collapse image" /><img id="expandImage" style="display:none; height:0; width:0;" src="../icons/expand_all.gif" title="Expand Image" /><img id="collapseAllImage" style="display:none; height:0; width:0;" src="../icons/collapse_all.gif" /><img id="expandAllImage" style="display:none; height:0; width:0;" src="../icons/expand_all.gif" /><img id="dropDownImage" style="display:none; height:0; width:0;" src="../icons/dropdown.gif" /><img id="dropDownHoverImage" style="display:none; height:0; width:0;" src="../icons/dropdownHover.gif" /><img id="copyImage" style="display:none; height:0; width:0;" src="../icons/copycode.gif" title="Copy image" /><img id="copyHoverImage" style="display:none; height:0; width:0;" src="../icons/copycodeHighlight.gif" title="CopyHover image" /><div id="header"><table id="topTable" cellspacing="0" cellpadding="0"><tr><td><span onclick="ExpandCollapseAll(toggleAllImage)" style="cursor:default;" onkeypress="ExpandCollapseAll_CheckKey(toggleAllImage, event)" tabindex="0"><img ID="toggleAllImage" class="toggleAll" src="../icons/collapse_all.gif" /> <label id="collapseAllLabel" for="toggleAllImage" style="display: none;">Collapse All</label><label id="expandAllLabel" for="toggleAllImage" style="display: none;">Expand All</label> </span></td></tr></table><div id="devlangsMenu"><input id="CSharpCheckbox" type="checkbox" data="CSharp,cs,'persist'" value="on" onClick="SetLanguage(this)" /><label class="checkboxLabel" for="CSharpCheckbox">C#</label><br /></div><table id="bottomTable" cellpadding="0" cellspacing="0"><tr id="headerTableRow1"><td align="left"><span id="runningHeaderText">P4.Net -- Managed API for Perforce</span></td></tr><tr id="headerTableRow2"><td align="left"><span id="nsrTitle">P4Form Class</span></td></tr><tr id="headerTableRow3"><td align="left"><a href="AllMembers_T_P4API_P4Form.htm">Members</a>  <a href="#exampleToggle" onclick="OpenSection(exampleToggle)">Example</a>  <a href="#seeAlsoToggle" onclick="OpenSection(seeAlsoToggle)">See Also</a>  <span id="headfb" class="feedbackhead" /></td></tr></table><table id="gradientTable"><tr><td class="nsrBottom" background="../icons/gradient.gif" /></tr></table></div><div id="mainSection"><div id="mainBody"><div id="allHistory" class="saveHistory" onsave="saveAll()" onload="loadAll()"><span style="color: DarkGray"> </span></div><div class="summary">
  2.             Represents a Perforce 'Form' object.
  3.             </div><p />
  4.     <b>Namespace:</b> 
  5.    <a href="N_P4API.htm">P4API</a><br />
  6.     <b>Assembly:</b>
  7.    p4api (in p4api)<br /><b>Version:</b> 1.0.0.0 (1.0.0)<h1 class="heading"><span onclick="ExpandCollapse(syntaxToggle)" style="cursor:default;" onkeypress="ExpandCollapse_CheckKey(syntaxToggle, event)" tabindex="0"><img id="syntaxToggle" onload="OnLoadImage(event)" class="toggle" name="toggleSwitch" src="../icons/collapse_all.gif" />Syntax</span></h1><div id="syntaxSection" class="section" name="collapseableSection" style=""><div id="syntaxCodeBlocks" class="code"><span codeLanguage="CSharp"><table><tr><th>C#</th></tr><tr><td><pre xml:space="preserve"><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">P4Form</span> : <a href="T_P4API_P4Record.htm">P4Record</a></pre></td></tr></table></span></div></div><h1 class="heading"><span onclick="ExpandCollapse(remarksToggle)" style="cursor:default;" onkeypress="ExpandCollapse_CheckKey(remarksToggle, event)" tabindex="0"><img id="remarksToggle" onload="OnLoadImage(event)" class="toggle" name="toggleSwitch" src="../icons/collapse_all.gif" />Remarks</span></h1><div id="remarksSection" class="section" name="collapseableSection" style="">
  8.         Forms are the things that pop-up in an editor when run from a command line.  In
  9.         P4.Net (and most other Perforce APIs), you do not need to parse/format the text manually.
  10.         Instead, you can get/set the fields using the Fields and ArrayFields collections.
  11.         The following is a list of common form commands:<li>client</li><li>branch</li><li>label</li><li>job</li><li>user</li><li>group</li><li>protect</li><li>triggers</li><li>branch</li>
  12.           When fetching or saving a form, do not use the '-o' and '-i' flags.  P4.Net will automatically include them.
  13.         </div><h1 class="heading"><span onclick="ExpandCollapse(exampleToggle)" style="cursor:default;" onkeypress="ExpandCollapse_CheckKey(exampleToggle, event)" tabindex="0"><img id="exampleToggle" onload="OnLoadImage(event)" class="toggle" name="toggleSwitch" src="../icons/collapse_all.gif" />Examples</span></h1><div id="exampleSection" class="section" name="collapseableSection" style="">
  14.         The following example updates the current client.  It changes the client root, and adds a line to the view.
  15.         <span id="cbc_1" x-lang="CSharp" codeLanguage="CSharp"><div class="highlight-title"><span class="highlight-copycode" onkeypress="javascript:CopyColorizedCodeCheckKey(this.parentNode, event);" tabindex="0" onmouseover="CopyCodeChangeIcon(this)" onmouseout="CopyCodeChangeIcon(this)" onclick="javascript:CopyColorizedCode(this.parentNode);"><img src="../icons/CopyCode.gif" style="margin-right: 5px;" />Copy</span>C#</div><div class="code"><span codeLanguage="CSharp"><pre>P4Connection p4 = <span class="highlight-keyword">new</span> P4Connection();
  16. p4.Connect();
  17.  
  18. P4Form MyClient = p4.Fetch_Form(<span class="highlight-literal">"client"</span>);
  19.  
  20. <span class="highlight-comment">//Change the root and properties</span>
  21. MyClient[<span class="highlight-literal">"Root"</span>] = <span class="highlight-literal">@"C:\p4\P4.NetClient"</span>;
  22. MyClient[<span class="highlight-literal">"Description"</span>] = <span class="highlight-literal">"Created from P4.Net!"</span>;
  23.  
  24. <span class="highlight-comment">//Fetch the clientName (for use later in building the view spec).</span>
  25. <span class="highlight-keyword">string</span> clientName = MyClient[<span class="highlight-literal">"Client"</span>];
  26.  
  27. <span class="highlight-comment">// Build a new array, that has one more element than the current view</span>
  28. <span class="highlight-keyword">string</span>[] NewView = <span class="highlight-keyword">new</span> <span class="highlight-keyword">string</span>[MyClient.ArrayFields[<span class="highlight-literal">"View"</span>].Length + <span class="highlight-number">1</span>];
  29.  
  30. <span class="highlight-comment">// Copy the existing view lines to the new array</span>
  31. MyClient.ArrayFields[<span class="highlight-literal">"View"</span>].CopyTo(NewView,<span class="highlight-number">0</span>);
  32.  
  33. <span class="highlight-comment">// Set the new view line</span>
  34. NewView[NewView.Length - <span class="highlight-number">1</span>] = <span class="highlight-keyword">string</span>.Format(<span class="highlight-literal">"//depot/newpath/... //{0}/newpath/..."</span>, clientName);
  35.  
  36. MyClient.ArrayFields[<span class="highlight-literal">"View"</span>] = NewView;
  37.  
  38. <span class="highlight-comment">// Save the form</span>
  39. P4UnParsedRecordSet MyResult = p4.Save_Form(MyClient);
  40. p4.Disconnect();</pre></span></div></span></div><h1 class="heading"><span onclick="ExpandCollapse(familyToggle)" style="cursor:default;" onkeypress="ExpandCollapse_CheckKey(familyToggle, event)" tabindex="0"><img id="familyToggle" onload="OnLoadImage(event)" class="toggle" name="toggleSwitch" src="../icons/collapse_all.gif" />Inheritance Hierarchy</span></h1><div id="familySection" class="section" name="collapseableSection" style=""><a href="http://msdn2.microsoft.com/en-us/e5kfa45b" target="_blank">System<span class="languageSpecificText"><span class="cs">.</span><span class="vb">.</span><span class="cpp">::</span><span class="nu">.</span></span>Object</a><br />  <a href="T_P4API_P4Record.htm">P4API<span class="languageSpecificText"><span class="cs">.</span><span class="vb">.</span><span class="cpp">::</span><span class="nu">.</span></span>P4Record</a><br />    <span class="selflink">P4API<span class="languageSpecificText"><span class="cs">.</span><span class="vb">.</span><span class="cpp">::</span><span class="nu">.</span></span>P4Form</span><br /></div><h1 class="heading"><span onclick="ExpandCollapse(seeAlsoToggle)" style="cursor:default;" onkeypress="ExpandCollapse_CheckKey(seeAlsoToggle, event)" tabindex="0"><img id="seeAlsoToggle" onload="OnLoadImage(event)" class="toggle" name="toggleSwitch" src="../icons/collapse_all.gif" />See Also</span></h1><div id="seeAlsoSection" class="section" name="collapseableSection" style=""><div class="seeAlsoStyle"><a href="AllMembers_T_P4API_P4Form.htm">P4Form Members</a></div><div class="seeAlsoStyle"><a href="N_P4API.htm">P4API Namespace</a></div></div></div><div id="footer"><div class="footerLine"><img width="100%" height="3px" src="../icons/footer.gif" title="Footer image" /></div><A NAME="feedback"></A><span id="fb" class="feedbackcss" style="display: none;"> </span>
  41. <a href="http://p4dotnet.sourceforge.net" target="_blank">P4.Net SourceForge Project Web Site</a> <p /><a href="Copyright.html">Copyright © 2007 Shawn Hladky</a><script type="text/javascript">
  42.           var feedb = new FeedBack(
  43.               '', 
  44.               'P4.Net -- Managed API for Perforce',
  45.               '', 
  46.               '', 
  47.               '',
  48.               fb,
  49.               '%0dYour%20feedback%20is%20used%20to%20improve%20the%20documentation%20and%20the%20product.%20Your%20e-mail%20address%20will%20not%20be%20used%20for%20any%20other%20purpose%20and%20is%20disposed%20of%20after%20the%20issue%20you%20report%20is%20resolved.%20%20While%20working%20to%20resolve%20the%20issue%20that%20you%20report,%20you%20may%20be%20contacted%20via%20e-mail%20to%20get%20further%20details%20or%20clarification%20on%20the%20feedback%20you%20sent.%20After%20the%20issue%20you%20report%20has%20been%20addressed,%20you%20may%20received%20an%20e-mail%20to%20let%20you%20know%20that%20your%20feedback%20has%20been%20addressed.%0A%0d');
  50.               
  51.             feedb.HeadFeedBack(headfb,
  52.               'Send Feedback',
  53.               'false');
  54.               
  55.             feedb.StartRatingsFeedBack(fb);
  56.               
  57.         </script></div></div></body></html>
# Change User Description Committed
#1 7291 Andrew McDonald initial submittal 16 years ago
//guest/shawn_hladky/P4.Net/main/doc/html/html/T_P4API_P4Form.htm
#1 6105 Shawn Hladky P4.Net: Updating documentation output to sandcastle. 17 years ago