P4API.P4Connection.Fetch_Form.html #3

  • //
  • guest/
  • shawn_hladky/
  • P4.Net/
  • main/
  • doc/
  • html/
  • P4API.P4Connection.Fetch_Form.html
  • View
  • Commits
  • Open Download .zip Download (4 KB)
<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.Fetch_Form 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.Fetch_FormMethod</h1>
</div>
</div>
    <div id="nstext">
      <p> Fetch a form object from Perforce. </p>
      <div class="syntax">
        <span class="lang">[VisualBasic]</span>
        <br />PublicFunctionFetch_Form( _<br />ByVal <i>FormCommand</i>As<a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemStringClassTopic.htm">String</a>,_<br />ParamArray <i>Args</i>As<a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemStringClassTopic.htm">String()</a>_<br />)As<a href="P4API.P4Form.html">P4Form</a></div>
      <div class="syntax">
        <span class="lang">[C#]</span>
        <br />public<a href="P4API.P4Form.html">P4Form</a>Fetch_Form(<br /><a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemStringClassTopic.htm">string</a><i>FormCommand</i>,<br />params<a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemStringClassTopic.htm">string[]</a><i>Args</i><br />);</div>
      <h4 class="dtH4">Parameters</h4>
      <dl>
        <dt>
          <i>FormCommand</i>
        </dt>
        <dd>The form command.</dd>
        <dt>
          <i>Args</i>
        </dt>
        <dd>The args.</dd>
      </dl>
      <h4 class="dtH4">Return Value</h4>
      <p> A Form object. The fields of the form can be read or updated. If you update a filed, you can save it with Save_Form. </p>
      <h4 class="dtH4">Remarks</h4>
      <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>
        <list>
          <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>
        </list>
        <P> When fetching or saving a form, <B>do not use the '-o' and '-i' flags</B>. P4.Net will automatically include them. </P>
      </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="Fetch_Form method">
        </param>
        <param name="Keyword" value="Fetch_Form method, P4Connection class">
        </param>
        <param name="Keyword" value="P4Connection.Fetch_Form 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
#3 7709 Shawn Hladky P4.Net:  Cleanup, documentation, and a a start for implementing an object-based output for filelog.
#2 6105 Shawn Hladky P4.Net: Updating documentation output to sandcastle.
#1 5830 Shawn Hladky P4.Net: reorg to support release branches
//guest/shawn_hladky/P4.Net/doc/html/P4API.P4Connection.Fetch_Form.html
#1 5812 Shawn Hladky P4.Net: More documentation.