179 lines
12 KiB
HTML
179 lines
12 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>DeleteFile Method (IEdmFolder5)</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.IEdmFolder5.DeleteFile" />
|
|
<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.IEdmFolder5~DeleteFile.html">Send Feedback</a></span></td>
|
|
</tr>
|
|
|
|
<tr id="pagetoptable1row2">
|
|
<td align="left" colspan="2"><span id="pagetitle">DeleteFile Method (IEdmFolder5)</span></td>
|
|
</tr>
|
|
|
|
<tr id="pagetoptable1row3">
|
|
<td colspan="2"><a onclick="javascript:openSectionById('seeAlsoSectionHeader');" href="#seealsobookmark">
|
|
See Also</a>
|
|
<a href="#ExampleBookmark" onclick="javascript:openSectionById('exampleSectionHeader');">Example</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.IEdmFolder5.html">IEdmFolder5 Interface</a>
|
|
: DeleteFile Method (IEdmFolder5)</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="lFileID_box" class="dxpopupbubble">
|
|
<DL><DT class="popupbubble"><I>lFileID</I></DT>
|
|
<DD class="popupbubble">ID of file to delete</DD></DL>
|
|
</div>
|
|
<div id="bRemoveLocalCopy_box" class="dxpopupbubble">
|
|
<DL><DT class="popupbubble"><I>bRemoveLocalCopy</I></DT>
|
|
<DD class="popupbubble">Optionally, true to erase the local copy of the file, false to not; default is true</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>
|
|
Deletes a file having the specified ID from this folder.
|
|
|
|
|
|
<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 DeleteFile( _
|
|
ByVal <i><a class="parameter" id="lParentWnd" href="#" onclick="javascript:showParamBox(event);">lParentWnd</a></i> As System.Integer, _
|
|
ByVal <i><a class="parameter" id="lFileID" href="#" onclick="javascript:showParamBox(event);">lFileID</a></i> As System.Integer, _
|
|
Optional ByVal <i><a class="parameter" id="bRemoveLocalCopy" href="#" onclick="javascript:showParamBox(event);">bRemoveLocalCopy</a></i> As System.Boolean _
|
|
) </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 DeleteFile(
|
|
System.int <i><a class="parameter" id="lParentWnd" href="#" onclick="javascript:showParamBox(event);">lParentWnd</a></i>,
|
|
System.int <i><a class="parameter" id="lFileID" href="#" onclick="javascript:showParamBox(event);">lFileID</a></i>,
|
|
System.bool <i><a class="parameter" id="bRemoveLocalCopy" href="#" onclick="javascript:showParamBox(event);">bRemoveLocalCopy</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 DeleteFile(
|
|
& System.int <i><a class="parameter" id="lParentWnd" href="#" onclick="javascript:showParamBox(event);">lParentWnd</a></i>,
|
|
& System.int <i><a class="parameter" id="lFileID" href="#" onclick="javascript:showParamBox(event);">lFileID</a></i>,
|
|
& System.bool <i><a class="parameter" id="bRemoveLocalCopy" href="#" onclick="javascript:showParamBox(event);">bRemoveLocalCopy</a></i>
|
|
) </pre></tr></table></div>
|
|
|
|
<h4 class=dxh4>Parameters</h4><DL><DT><I>lParentWnd</I></DT>
|
|
<DD>Parent window handle</DD><DT><I>lFileID</I></DT>
|
|
<DD>ID of file to delete</DD><DT><I>bRemoveLocalCopy</I></DT>
|
|
<DD>Optionally, true to erase the local copy of the file, false to not; default is true</DD></DL>
|
|
|
|
</div>
|
|
|
|
<a name="exampleBookmark"></a>
|
|
|
|
|
|
<h1 class="heading"><span class="expandcollapse" tabindex="0"><img id="exampleToggle" class="toggle" name="toggleSwitch" src="dotnetimages/collapse.gif"></img>Example</span></h1><div id="exampleSection" class="section" name="collapseableSection"><a href="Vault_Utilities_Example_VBNET.htm">Vault Utilities (VB.NET)</a>
|
|
<br/><a href="Vault_Utilities_Example_CSharp.htm">Vault Utilities (C#)</a>
|
|
</div>
|
|
<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>If the specified file is shared to other folders, it is deleted only from this folder.</P>
|
|
<P><A href="ReturnCodes.htm">Return codes</A>:</P>
|
|
<UL>
|
|
<LI>S_OK: The method successfully executed.
|
|
<LI>E_EDM_FILE_NOT_FOUND: The file ID is invalid.
|
|
<LI>E_EDM_OPERATION_REFUSED_BY_PLUGIN: The operation is not permitted by one of the installed <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmCmdData.html">EdmCmdData</A>.EdmCmd_PreDelete hooks.
|
|
<LI>E_EDM_LOCKED_BY_ANOTHER_USER: The file cannot be deleted since it is checked out by another user.
|
|
<LI>E_EDM_PERMISSION_DENIED: The user lacks permission to delete the file. </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.IEdmFolder5.html">IEdmFolder5 Interface</a>
|
|
<br/><a href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmFolder5_members.html">IEdmFolder5 Members</a>
|
|
<br/><a href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmFolder5~DeleteFolder.html">IEdmFolder5::DeleteFolder Method ()</a>
|
|
<br/><a href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmFolder11~RecoverDeletedItems.html">IEdmFolder11::RecoverDeletedItems Method ()</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> |