<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>LoadFromSpec 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_P4Form_LoadFromSpec" /><meta name="guid" content="M_P4API_P4Form_LoadFromSpec" /><xml><MSHelp:TOCTitle Title="LoadFromSpec Method " /><MSHelp:RLTitle Title="P4Form.LoadFromSpec Method (P4API)" /><MSHelp:Attr Name="AssetID" Value="M:P4API.P4Form.LoadFromSpec(System.String,System.String,System.String,System.Text.Encoding)" /><MSHelp:Keyword Index="A" Term="M:P4API.P4Form.LoadFromSpec(System.String,System.String,System.String,System.Text.Encoding)" /><MSHelp:Keyword Index="A" Term="frlrfP4APIP4FormClassLoadFromSpecTopic" /><MSHelp:Keyword Index="K" Term="LoadFromSpec method" /><MSHelp:Keyword Index="K" Term="P4Form.LoadFromSpec method" /><MSHelp:Keyword Index="F" Term="LoadFromSpec" /><MSHelp:Keyword Index="F" Term="P4Form.LoadFromSpec" /><MSHelp:Keyword Index="F" Term="P4API.P4Form.LoadFromSpec" /><MSHelp:Attr Name="APIType" Value="Managed" /><MSHelp:Attr Name="APILocation" Value="p4api.dll" /><MSHelp:Attr Name="APIName" Value="P4API.P4Form.LoadFromSpec" /><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="Parses a Perforce form without making a server connection." /></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">P4Form<span class="languageSpecificText"><span class="cs">.</span><span class="vb">.</span><span class="cpp">::</span><span class="nu">.</span></span>LoadFromSpec Method </span></td></tr><tr id="headerTableRow3"><td align="left"><a href="T_P4API_P4Form.htm">P4Form 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">
Parses a Perforce form without making a server connection.
</div><p />
<b>Namespace:</b>
<a href="N_P4API.htm">P4API</a><br />
<b>Assembly:</b>
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">static</span> <a href="T_P4API_P4Form.htm">P4Form</a> <span class="identifier">LoadFromSpec</span>(
<a href="http://msdn2.microsoft.com/en-us/s1wwdcbf" target="_blank">string</a> <span class="parameter">formCommand</span>,
<a href="http://msdn2.microsoft.com/en-us/s1wwdcbf" target="_blank">string</a> <span class="parameter">specDef</span>,
<a href="http://msdn2.microsoft.com/en-us/s1wwdcbf" target="_blank">string</a> <span class="parameter">formContents</span>,
<a href="http://msdn2.microsoft.com/en-us/86hf4sb8" target="_blank">Encoding</a> <span class="parameter">encoding</span>
)</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 command that would otherwise be used to fetch the form.</dd></dl><dl paramName="specDef"><dt><span class="parameter">specDef</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 Perforce 'specdef' for the form.</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 />The raw formated form text.</dd></dl><dl paramName="encoding"><dt><span class="parameter">encoding</span></dt><dd>Type: <a href="http://msdn2.microsoft.com/en-us/86hf4sb8" target="_blank">System.Text<span class="languageSpecificText"><span class="cs">.</span><span class="vb">.</span><span class="cpp">::</span><span class="nu">.</span></span>Encoding</a><br />Server encoding (either ANSI or UFT-8).</dd></dl><h4 class="subHeading">Return Value</h4>A Perforce form object.</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="">
LoadFromSpec can be used to parse a form without making a call to the server.
LoadFromSpec can be useful in form triggers.
It does require you to know the SpecDef to call, which can change when upgrading or changing
the server configuration.
</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_P4Form.htm">P4Form 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>
<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">
var feedb = new FeedBack(
'',
'P4.Net -- Managed API for Perforce',
'',
'',
'',
fb,
'%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');
feedb.HeadFeedBack(headfb,
'Send Feedback',
'false');
feedb.StartRatingsFeedBack(fb);
</script></div></div></body></html>
| # |
Change |
User |
Description |
Committed |
|
|
#1
|
7291 |
Andrew McDonald |
initial submittal |
|
|
|
//guest/shawn_hladky/P4.Net/main/doc/html/html/M_P4API_P4Form_LoadFromSpec.htm |
|
#1
|
6105 |
Shawn Hladky |
P4.Net: Updating documentation output to sandcastle. |
|
|