Loading...
Helix SwarmHelix Swarm
Loading...

M_P4API_P4Connection_Parse_Form.htm

  • //
  • guest/
  • shawn_hladky/
  • P4.Net/
  • doc/
  • html/
  • html/
  • M_P4API_P4Connection_Parse_Form.htm #1
  • View
  • Commits
  • Open Download .zip Download (10 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>Parse_Form Method </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="M_P4API_P4Connection_Parse_Form" /><meta name="guid" content="M_P4API_P4Connection_Parse_Form" /><xml><MSHelp:TOCTitle Title="Parse_Form Method " /><MSHelp:RLTitle Title="P4Connection.Parse_Form Method  (P4API)" /><MSHelp:Attr Name="AssetID" Value="M:P4API.P4Connection.Parse_Form(System.String,System.String)" /><MSHelp:Keyword Index="A" Term="M:P4API.P4Connection.Parse_Form(System.String,System.String)" /><MSHelp:Keyword Index="A" Term="frlrfP4APIP4ConnectionClassParse_FormTopic" /><MSHelp:Keyword Index="K" Term="Parse_Form method" /><MSHelp:Keyword Index="K" Term="P4Connection.Parse_Form method" /><MSHelp:Keyword Index="F" Term="Parse_Form" /><MSHelp:Keyword Index="F" Term="P4Connection.Parse_Form" /><MSHelp:Keyword Index="F" Term="P4API.P4Connection.Parse_Form" /><MSHelp:Attr Name="APIType" Value="Managed" /><MSHelp:Attr Name="APILocation" Value="p4api.dll" /><MSHelp:Attr Name="APIName" Value="P4API.P4Connection.Parse_Form" /><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="Parse the raw text of a Perforce form into a P4Form object" /></xml></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">P4Connection<span class="languageSpecificText"><span class="cs">.</span><span class="vb">.</span><span class="cpp">::</span><span class="nu">.</span></span>Parse_Form Method </span></td></tr><tr id="headerTableRow3"><td align="left"><a href="T_P4API_P4Connection.htm">P4Connection Class</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.             Parse the raw text of a Perforce form into a P4Form 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> <a href="T_P4API_P4Form.htm">P4Form</a> <span class="identifier">Parse_Form</span>(
  8. 	<a href="http://msdn2.microsoft.com/en-us/s1wwdcbf" target="_blank">string</a> <span class="parameter">formCommand</span>,
  9. 	<a href="http://msdn2.microsoft.com/en-us/s1wwdcbf" target="_blank">string</a> <span class="parameter">formContents</span>
  10. )</pre></td></tr></table></span></div><h4 class="subHeading">Parameters</h4><dl paramName="formCommand"><dt><span class="parameter">formCommand</span></dt><dd>Type: <a href="http://msdn2.microsoft.com/en-us/s1wwdcbf" target="_blank">System<span class="languageSpecificText"><span class="cs">.</span><span class="vb">.</span><span class="cpp">::</span><span class="nu">.</span></span>String</a><br />The form command.</dd></dl><dl paramName="formContents"><dt><span class="parameter">formContents</span></dt><dd>Type: <a href="http://msdn2.microsoft.com/en-us/s1wwdcbf" target="_blank">System<span class="languageSpecificText"><span class="cs">.</span><span class="vb">.</span><span class="cpp">::</span><span class="nu">.</span></span>String</a><br />Raw contents of the form spec.</dd></dl><h4 class="subHeading">Return Value</h4>
  11.             A P4Form object.  The fields of the form can be read or updated.  If you update a filed, you can save it with Save_Form.
  12.             </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="">
  13.         Forms are the things that pop-up in an editor when run from a command line.  In
  14.         P4.Net (and most other Perforce APIs), you do not need to parse/format the text manually.
  15.         Instead, you can get/set the fields using the Fields and ArrayFields collections.
  16.         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>
  17.           When fetching or saving a form, do not use the '-o' and '-i' flags.  P4.Net will automatically include them.
  18.         </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="T_P4API_P4Connection.htm">P4Connection Class</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>
  19. <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">
  20.           var feedb = new FeedBack(
  21.               '', 
  22.               'P4.Net -- Managed API for Perforce',
  23.               '', 
  24.               '', 
  25.               '',
  26.               fb,
  27.               '%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');
  28.               
  29.             feedb.HeadFeedBack(headfb,
  30.               'Send Feedback',
  31.               'false');
  32.               
  33.             feedb.StartRatingsFeedBack(fb);
  34.               
  35.         </script></div></div></body></html>
# Change User Description Committed
#1 6112 Shawn Hladky P4.Net: updating latest html documentation to 1.0. 17 years ago
//guest/shawn_hladky/P4.Net/release/1.0/doc/html/html/M_P4API_P4Connection_Parse_Form.htm
#1 6106 Shawn Hladky P4.Net: Branching release 1.0 17 years ago
//guest/shawn_hladky/P4.Net/main/doc/html/html/M_P4API_P4Connection_Parse_Form.htm
#1 6105 Shawn Hladky P4.Net: Updating documentation output to sandcastle. 17 years ago