197 lines
14 KiB
HTML
197 lines
14 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>ChangeState 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.ChangeState" />
|
||
<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~ChangeState.html">Send Feedback</a></span></td>
|
||
</tr>
|
||
|
||
<tr id="pagetoptable1row2">
|
||
<td align="left" colspan="2"><span id="pagetitle">ChangeState Method (IEdmFile5)</span></td>
|
||
</tr>
|
||
|
||
<tr id="pagetoptable1row3">
|
||
<td colspan="2"><a onclick="javascript:openSectionById('seeAlsoSectionHeader');" href="#seealsobookmark">
|
||
See Also</a>
|
||
</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>
|
||
: ChangeState 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="poStateIdOrName_box" class="dxpopupbubble">
|
||
<DL><DT class="popupbubble"><I>poStateIdOrName</I></DT>
|
||
<DD class="popupbubble">Workflow state ID or name or <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmState5.html">IEdmState5</A> to which this file transitions (see <STRONG>Remarks</STRONG>)</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 active parent folder</DD></DL>
|
||
</div>
|
||
<div id="bsComment_box" class="dxpopupbubble">
|
||
<DL><DT class="popupbubble"><I>bsComment</I></DT>
|
||
<DD class="popupbubble">Comment saved to the transition history</DD></DL>
|
||
</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="lEdmStateFlags_box" class="dxpopupbubble">
|
||
<DL><DT class="popupbubble"><I>lEdmStateFlags</I></DT>
|
||
<DD class="popupbubble">Optional combination of <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmStateFlags.html">EdmStateFlags</A> bits; default is EdmStateFlags.EdmState_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>
|
||
<SPAN style="COLOR: #ff0000"><SPAN style="COLOR: #ff0000">Obsolete. Superseded by </SPAN><A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmFile10~ChangeState2.html">IEdmFile10::ChangeState2<SPAN style="COLOR: #ff0000">.</SPAN></A><FONT color=#000000> </FONT></SPAN>
|
||
|
||
|
||
<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> </th></tr><tr><td colspan="2"><pre>Sub ChangeState( _
|
||
ByRef <i><a class="parameter" id="poStateIdOrName" href="#" onclick="javascript:showParamBox(event);">poStateIdOrName</a></i> As System.Object, _
|
||
ByVal <i><a class="parameter" id="lFolderID" href="#" onclick="javascript:showParamBox(event);">lFolderID</a></i> As System.Integer, _
|
||
ByVal <i><a class="parameter" id="bsComment" href="#" onclick="javascript:showParamBox(event);">bsComment</a></i> As System.String, _
|
||
ByVal <i><a class="parameter" id="lParentWnd" href="#" onclick="javascript:showParamBox(event);">lParentWnd</a></i> As System.Integer, _
|
||
Optional ByVal <i><a class="parameter" id="lEdmStateFlags" href="#" onclick="javascript:showParamBox(event);">lEdmStateFlags</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> </th></tr><tr><td colspan="2"><pre>void ChangeState(
|
||
ref System.object <i><a class="parameter" id="poStateIdOrName" href="#" onclick="javascript:showParamBox(event);">poStateIdOrName</a></i>,
|
||
System.int <i><a class="parameter" id="lFolderID" href="#" onclick="javascript:showParamBox(event);">lFolderID</a></i>,
|
||
System.string <i><a class="parameter" id="bsComment" href="#" onclick="javascript:showParamBox(event);">bsComment</a></i>,
|
||
System.int <i><a class="parameter" id="lParentWnd" href="#" onclick="javascript:showParamBox(event);">lParentWnd</a></i>,
|
||
System.int <i><a class="parameter" id="lEdmStateFlags" href="#" onclick="javascript:showParamBox(event);">lEdmStateFlags</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> </th></tr><tr><td colspan="2"><pre>void ChangeState(
|
||
& System.Object^% <i><a class="parameter" id="poStateIdOrName" href="#" onclick="javascript:showParamBox(event);">poStateIdOrName</a></i>,
|
||
& System.int <i><a class="parameter" id="lFolderID" href="#" onclick="javascript:showParamBox(event);">lFolderID</a></i>,
|
||
& System.String^ <i><a class="parameter" id="bsComment" href="#" onclick="javascript:showParamBox(event);">bsComment</a></i>,
|
||
& System.int <i><a class="parameter" id="lParentWnd" href="#" onclick="javascript:showParamBox(event);">lParentWnd</a></i>,
|
||
& System.int <i><a class="parameter" id="lEdmStateFlags" href="#" onclick="javascript:showParamBox(event);">lEdmStateFlags</a></i>
|
||
) </pre></tr></table></div>
|
||
|
||
<h4 class=dxh4>Parameters</h4><DL><DT><I>poStateIdOrName</I></DT>
|
||
<DD>Workflow state ID or name or <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmState5.html">IEdmState5</A> to which this file transitions (see <STRONG>Remarks</STRONG>)</DD><DT><I>lFolderID</I></DT>
|
||
<DD>ID of the file's active parent folder</DD><DT><I>bsComment</I></DT>
|
||
<DD>Comment saved to the transition history</DD><DT><I>lParentWnd</I></DT>
|
||
<DD>Parent window handle</DD><DT><I>lEdmStateFlags</I></DT>
|
||
<DD>Optional combination of <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmStateFlags.html">EdmStateFlags</A> bits; default is EdmStateFlags.EdmState_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>There must be a transition between the current state and poStateIdOrName, or this method fails.</P>
|
||
<P>It is possible to create multiple workflows with two or more states having the same name. If poStateIdOrName contains the name of the destination state instead of its ID, and if several transitions from the file’s current state lead to new states all having the same name, SOLIDWORKS PDM Professional randomly selects one of them. To be sure to which state the file transitions, specify a state ID in poStateIdOrName.</P>
|
||
<P>See <A href="ReturnCodes.htm">Return Codes</A> for the complete list of potential success and error codes. The following are just a few examples:</P>
|
||
<UL>
|
||
<LI>S_OK: The method successfully executed.
|
||
<LI>E_EDM_TRANSITION_ACTION_FAILED: One of the transition actions set up in the workflow failed.
|
||
<LI>E_EDM_OPERATION_REFUSED_BY_PLUGIN: One of the <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmCmdType.html">EdmCmdType.EdmCmd_PreState</A> hooks did not permit the operation.
|
||
<LI>E_EDM_FILE_IS_LOCKED: The file is checked out. Changing state is only permitted on checked-in files.
|
||
<LI>E_EDM_PERMISSION_DENIED: The logged-in user lacks permission to change state.
|
||
<LI>E_EDM_CONDITIONS_NOT_MET: The conditions set up in the Workflow Editor for this transition were not met.
|
||
<LI>E_EDM_STATE_NOT_FOUND: There is no transition going from the file's current state to the specified state.</LI></UL></div>
|
||
<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>
|
||
<br/><a href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmWorkflow5.html">IEdmWorkflow5 Interface</a>
|
||
<br/><a href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmState5.html">IEdmState5 Interface</a>
|
||
<br/><a href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmTransition5.html">IEdmTransition5 Interface</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> |