Files
pdm/documentation/api_extracted/EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmFile5~IncrementRevision.html

182 lines
13 KiB
HTML

<html xmlns:mshelp="http://msdn.microsoft.com/mshelp">
<head>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8">
<meta content="history" name="save">
<meta content="Innovasys Document! X (http://www.innovasys.com)" name="GENERATOR">
<title>IncrementRevision Method (IEdmFile5)</title>
<link href="stylesheets/dotnet2005.css" type="text/css" rel="stylesheet">
<script src="script/dotnet2005.js" type="text/javascript">
</script><xml>
<MSHelp:Keyword Index="F" Term="EPDM.Interop.epdm.IEdmFile5.IncrementRevision" />
<MSHelp:Attr Name="DevLang" Value="CSharp" />
<MSHelp:Attr Name="DevLang" Value="VB" />
<MSHelp:Attr Name="DevLang" Value="JScript" />
<MSHelp:Attr Name="TopicType" Value="kbSyntax"/>
<MSHelp:Attr Name="LinkGroup" Value="Help"/>
<MSHelp:Attr Name="Locale" Value="kbEnglish"/>
<MSHelp:Attr Name="HelpPriority" Value="1"/>
</xml>
<script src="script/hs-expandcollapse.js" type="text/javascript"></script>
<script src="script/hs-enlargeimage.js" type="text/javascript"></script>
<script src="script/swfobject.js" type="text/javascript"></script>
<script src="script/hs-common.js" type="text/javascript"></script>
<script src="script/hs-heading-expandcollapse.js" type="text/javascript"></script>
<script src="script/hs-tabstrip.js" type="text/javascript"></script>
</head>
<body id="dxBody" topmargin="0">
<form>
<input class="userDataStyle" id="userDataCache" type="hidden" name="userDataCache"> <input id="hiddenScrollOffset" type="hidden" name=
"hiddenScrollOffset"> <img id="collapseImage" style="DISPLAY: none; WIDTH: 0px; HEIGHT: 0px" src="dotnetimages/collapse.gif"> <img id="expandImage"
style="DISPLAY: none; WIDTH: 0px; HEIGHT: 0px" src="dotnetimages/expand.gif"> <img id="collapseAllImage" style="DISPLAY: none; WIDTH: 0px; HEIGHT: 0px"
src="dotnetimages/collapse.gif"> <img id="expandAllImage" style="DISPLAY: none; WIDTH: 0px; HEIGHT: 0px" src="dotnetimages/expand.gif"> <img id=
"dropDownImage" style="DISPLAY: none; WIDTH: 0px; HEIGHT: 0px" src="dotnetimages/drpdown.gif"> <img id="dropDownHoverImage" style=
"DISPLAY: none; WIDTH: 0px; HEIGHT: 0px" src="dotnetimages/drpdown_orange.gif"> <img id="copyImage" style="DISPLAY: none; WIDTH: 0px; HEIGHT: 0px" src=
"dotnetimages/copycode.gif"> <img id="copyHoverImage" style="DISPLAY: none; WIDTH: 0px; HEIGHT: 0px" src="dotnetimages/copycodeHighlight.gif">
</form>
<div id="pagetop">
<table id="pagetoptable1" width="100%">
<tbody>
<tr id="pagetoptable1row1">
<td align="left"><span id="projecttitle">SOLIDWORKS PDM Professional API Help</span></td>
<td align="right"><span id="feedbacklink"><a href="mailto:apihelp.feedback@3ds.com?subject=Documentation Feedback: EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmFile5~IncrementRevision.html">Send Feedback</a></span></td>
</tr>
<tr id="pagetoptable1row2">
<td align="left" colspan="2"><span id="pagetitle">IncrementRevision Method (IEdmFile5)</span></td>
</tr>
<tr id="pagetoptable1row3">
<td colspan="2"><a onclick="javascript:openSectionById('seeAlsoSectionHeader');" href="#seealsobookmark">
See Also</a>&nbsp;
</td>
</tr>
</tbody>
</table>
<table id="pagetoptable2" cellspacing="0" cellpadding="0" width="100%">
<tbody>
<tr>
<td><span id="toggleExpandedAll"><img class="toggleAll" id="toggleExpandedAllImage" src="dotnetimages/collapse.gif"> <label id=
"collapseAllLabel" style="DISPLAY: none" for="toggleExpandedAllImage">Collapse All</label> <label id="expandAllLabel" style="DISPLAY: none" for="toggleExpandedAllImage">
Expand All</label></span> <span id="languageFilterToolTip"
onmouseover='document.getElementById("languageFilterImage").src=document.getElementById("dropDownHoverImage").src;' style="CURSOR: default"
onfocusout='document.getElementById("languageFilterImage").src=document.getElementById("dropDownImage").src;' onclick=
"showBox('dxlanguagemenu',event,document.getElementById('languageFilterImage'))" onfocusin=
'document.getElementById("languageFilterImage").src=document.getElementById("dropDownHoverImage").src;' onmouseout=
'document.getElementById("languageFilterImage").src=document.getElementById("dropDownImage").src;'><img id="languageFilterImage" src=
"dotnetimages/drpdown.gif"> <label id="showAllLabel" style="DISPLAY: none" for="languageFilterImage">
Language Filter: All</label> <label id="multipleLabel" style=
"DISPLAY: none" for="languageFilterImage">Language Filter: Multiple</label>
<label id="VBLabel" for="languageFilterImage" style="display: none;">Language Filter: Visual Basic</label>
<label id="CSLabel" for="languageFilterImage" style="display: none;">Language Filter: C#</label>
<label id="CPP2005Label" for="languageFilterImage" style="display: none;">Language Filter: C++/CLI</label>
</span></td>
</tr>
</tbody>
</table><table width="100%" id="pagetopbreadcrumbs" cellspacing="0" cellpadding="0"><tr><td>
<a href="EPDM.Interop.epdm~EPDM.Interop.epdm_namespace.html">EPDM.Interop.epdm Namespace</a>
> <a href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmFile5.html">IEdmFile5 Interface</a>
: IncrementRevision Method (IEdmFile5)</td></tr></table>
<div class="dxpopupbubble" id="dxlanguagemenu">
<input id="VBCheckbox" type="checkbox" name="languageFilter" onClick="setLanguage(this)" />
<label class="languageFilter" for="VBCheckbox">
Visual Basic
</label>
<br /><input id="CSCheckbox" type="checkbox" name="languageFilter" onClick="setLanguage(this)" />
<label class="languageFilter" for="CSCheckbox">
C#
</label>
<br /><input id="CPP2005Checkbox" type="checkbox" name="languageFilter" onClick="setLanguage(this)" />
<label class="languageFilter" for="CPP2005Checkbox">
C++/CLI
</label>
</div>
<div id="lParentWnd_box" class="dxpopupbubble">
<DL><DT class="popupbubble"><I>lParentWnd</I></DT>
<DD class="popupbubble">Parent window handle</DD></DL>
</div>
<div id="lFolderID_box" class="dxpopupbubble">
<DL><DT class="popupbubble"><I>lFolderID</I></DT>
<DD class="popupbubble">ID of the file's parent folder (see <STRONG>Remarks</STRONG>)</DD></DL>
</div>
<div id="bsComment_box" class="dxpopupbubble">
<DL><DT class="popupbubble"><I>bsComment</I></DT>
<DD class="popupbubble">Comment to store in revision history</DD></DL>
</div>
<div id="lEdmIncRevFlags_box" class="dxpopupbubble">
<DL><DT class="popupbubble"><I>lEdmIncRevFlags</I></DT>
<DD class="popupbubble">Optional combination of <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmIncRevFlags.html">EdmIncRevFlags</A> bits; default is EdmIncRevFlags.EdmIncRev_Simple</DD></DL>
</div>
</div>
<div id="pagebody" valign="bottom">
<a name="topBookmark"></a>
<div id="mainbody">
<div class="saveHistory" id="allHistory" onsave="saveAll()" onload="loadAll()"></div>
Creates a new revision of this file.
<h1 class="heading"><span class="expandcollapse" tabindex="0"><img id="syntaxToggle" class="toggle" name="toggleSwitch" src="dotnetimages/collapse.gif"></img>Syntax</span></h1><div id="syntaxSection" class="section" name="collapseableSection"><DIV class=LanguageSpecific id=Syntax_VB><table class="syntaxtable" width="100%" cellpadding="0" cellspacing="0"><tr><th>Visual Basic</th><th>&nbsp;</th></tr><tr><td colspan="2"><pre>Sub IncrementRevision( _
&nbsp;&nbsp;&nbsp;ByVal <i><a class="parameter" id="lParentWnd" href="#" onclick="javascript:showParamBox(event);">lParentWnd</a></i> As System.Integer, _
&nbsp;&nbsp;&nbsp;ByVal <i><a class="parameter" id="lFolderID" href="#" onclick="javascript:showParamBox(event);">lFolderID</a></i> As System.Integer, _
&nbsp;&nbsp;&nbsp;ByVal <i><a class="parameter" id="bsComment" href="#" onclick="javascript:showParamBox(event);">bsComment</a></i> As System.String, _
&nbsp;&nbsp;&nbsp;Optional ByVal <i><a class="parameter" id="lEdmIncRevFlags" href="#" onclick="javascript:showParamBox(event);">lEdmIncRevFlags</a></i> As System.Integer _
) </pre></tr></table></div>
<DIV class=LanguageSpecific id=Syntax_CS><table class="syntaxtable" width="100%" cellpadding="0" cellspacing="0"><tr><th>C#</th><th>&nbsp;</th></tr><tr><td colspan="2"><pre>void IncrementRevision(
&nbsp;&nbsp;&nbsp;System.int <i><a class="parameter" id="lParentWnd" href="#" onclick="javascript:showParamBox(event);">lParentWnd</a></i>,
&nbsp;&nbsp;&nbsp;System.int <i><a class="parameter" id="lFolderID" href="#" onclick="javascript:showParamBox(event);">lFolderID</a></i>,
&nbsp;&nbsp;&nbsp;System.string <i><a class="parameter" id="bsComment" href="#" onclick="javascript:showParamBox(event);">bsComment</a></i>,
&nbsp;&nbsp;&nbsp;System.int <i><a class="parameter" id="lEdmIncRevFlags" href="#" onclick="javascript:showParamBox(event);">lEdmIncRevFlags</a></i>
)</pre></tr></table></div>
<DIV class=LanguageSpecific id=Syntax_CPP2005><table class="syntaxtable" width="100%" cellpadding="0" cellspacing="0"><tr><th>C++/CLI</th><th>&nbsp;</th></tr><tr><td colspan="2"><pre>void IncrementRevision(
&&nbsp;&nbsp;&nbsp;System.int <i><a class="parameter" id="lParentWnd" href="#" onclick="javascript:showParamBox(event);">lParentWnd</a></i>,
&&nbsp;&nbsp;&nbsp;System.int <i><a class="parameter" id="lFolderID" href="#" onclick="javascript:showParamBox(event);">lFolderID</a></i>,
&&nbsp;&nbsp;&nbsp;System.String^ <i><a class="parameter" id="bsComment" href="#" onclick="javascript:showParamBox(event);">bsComment</a></i>,
&&nbsp;&nbsp;&nbsp;System.int <i><a class="parameter" id="lEdmIncRevFlags" href="#" onclick="javascript:showParamBox(event);">lEdmIncRevFlags</a></i>
) </pre></tr></table></div>
<h4 class=dxh4>Parameters</h4><DL><DT><I>lParentWnd</I></DT>
<DD>Parent window handle</DD><DT><I>lFolderID</I></DT>
<DD>ID of the file's parent folder (see <STRONG>Remarks</STRONG>)</DD><DT><I>bsComment</I></DT>
<DD>Comment to store in revision history</DD><DT><I>lEdmIncRevFlags</I></DT>
<DD>Optional combination of <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmIncRevFlags.html">EdmIncRevFlags</A> bits; default is EdmIncRevFlags.EdmIncRev_Simple</DD></DL>
</div>
<a name="exampleBookmark"></a>
<h1 class="heading"><span class="expandcollapse" tabindex="0"><img id="remarksToggle" class="toggle" name="toggleSwitch" src="dotnetimages/collapse.gif"></img>Remarks</span></h1><div id="remarksSection" class="section" name="collapseableSection"><P>Every time you check in a file in SOLIDWORKS PDM Professional, a new version of it is created. Versions are denoted by numbers: 1,2,3...N. In addition to versions you can also have revisions, which can be described as labels for certain versions. Revision numbers are generated by revision number generators which are set up in the Workflow Editor. Revisions let each company specify their own numbering system.</P>
<P>To specify lFolderID, inspect all of the parent folders of this file by&nbsp;calling <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmFile5~GetFirstFolderPosition.html">IEdmFile5::GetFirstFolderPosition</A> and <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmFile5~GetNextFolder.html">IEdmFile5::GetNextFolder</A>.</P>
<P>See <A href="ReturnCodes.htm">Return Codes</A>&nbsp;for the complete list of potential success and error codes. The following are&nbsp;just a few examples:</P>
<UL>
<LI>S_OK: The method successfully executed.
<LI>E_EDM_FILE_IS_LOCKED: To increment revision of a file, the file must not be checked out.
<LI>E_EDM_END_OF_REV_GEN_LIST_STOP: It&nbsp;is not possible to increment revision on this file, because SOLIDWORKS PDM Professional has reached the end of the revision list that was set up in the Workflow Editor.</LI></UL></div>&nbsp;
<a name="seealsobookmark"></a>
<h1 class="heading"><span class="expandcollapse" tabindex="0"><img id="seealsoToggle" class="toggle" name="toggleSwitch" src="dotnetimages/collapse.gif"></img>See Also</span></h1><div id="seealsoSection" class="section" name="collapseableSection"><h4 class="dxh4"></h4><a href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmFile5.html">IEdmFile5 Interface</a>
<br/><a href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmFile5_members.html">IEdmFile5 Members</a>
</p>
</div>
<h1 class="heading"><span class="expandcollapse" tabindex="0"><img id="availabilityToggle" class="toggle" name="toggleSwitch" src="dotnetimages/collapse.gif"></img>Availability</span></h1><div id="availabilitySection" class="section" name="collapseableSection">SOLIDWORKS PDM Professional Version 5.2</div>
</div>
<div id="pagefooter"></div>
</div>
</body>
</html>