Dws.DeleteFolder メソッド (websvcDocumentWorkspace)

現在のドキュメント ワークスペース サイトのドキュメント ライブラリから、サブフォルダを削除します。

名前空間: websvcDocumentWorkspace
アセンブリ: STSSOAP (stssoap.dll 内)

構文

'宣言
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/dws/DeleteFolder", RequestNamespace:="https://schemas.microsoft.com/sharepoint/soap/dws/", ResponseNamespace:="https://schemas.microsoft.com/sharepoint/soap/dws/", Use:=SoapBindingUse.Literal, ParameterStyle:=SoapParameterStyle.Wrapped)> _
Public Function DeleteFolder ( _
    url As String _
) As String
'使用
Dim instance As Dws
Dim url As String
Dim returnValue As String

returnValue = instance.DeleteFolder(url)

[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/dws/DeleteFolder", RequestNamespace="https://schemas.microsoft.com/sharepoint/soap/dws/", ResponseNamespace="https://schemas.microsoft.com/sharepoint/soap/dws/", Use=SoapBindingUse.Literal, ParameterStyle=SoapParameterStyle.Wrapped)] 
public string DeleteFolder (
    string url
)

パラメータ

• url
  String。削除するフォルダの、サイトに基づいた URL ("共有ドキュメント/フォルダ名" など)。

戻り値

成功した場合は、空の <Result/> タグを返す文字列。

例外

例外の種類	条件
DWSError.NoAccess (3)	ユーザーは適切な権限を持っていません。
DWSError.FolderNotFound (10)	親フォルダが存在しません。

備考

DeleteFolder メソッドは、現在のドキュメント ワークスペース サイトのドキュメント ライブラリから、サブフォルダとその内容を警告せずに削除します。

例

以下のコード例では、DeleteFolder メソッドを使用して、現在のサイトのドキュメント ライブラリからサブフォルダを削除する方法を示します。削除するフォルダの絶対 URL は、http://server_name/sites/user_name/workspace_name/Shared Documents/folder_name です。この例で使用されているヘルパ関数の全文の詳細については、CanCreateDwsUrl メソッドを参照してください。

Try
    Dim strResult As String
    strResult = 
        dwsWebService.DeleteFolder("Shared Documents/folder_name")
    If IsDwsErrorResult(strResult) Then
        Dim intErrorID As Integer
        Dim strErrorMsg As String
        Call ParseDwsErrorResult(strResult, intErrorID, strErrorMsg)
        MessageBox.Show _
            ("A document workspace error occurred." & vbCrLf & _
            "Error number: " & intErrorID.ToString & vbCrLf & _
            "Error description:" & strErrorMsg, _
            "DWS Error", MessageBoxButtons.OK, MessageBoxIcon.Error)
    Else
        MessageBox.Show("The folder was successfully deleted.", _
            "Delete Folder", MessageBoxButtons.OK, _
            MessageBoxIcon.Information)
    End If
Catch exc As Exception
    MessageBox.Show("An exception occurred." & vbCrLf & _
        "Description: " & exc.Message, _
        "Exception", MessageBoxButtons.OK, MessageBoxIcon.Error)
End Try

try
{
    string strResult = "";
    strResult = 
        dwsWebService.DeleteFolder("Shared Documents/folder_name");
    if (IsDwsErrorResult(strResult))
    {
        int intErrorID  = 0;
        string strErrorMsg = "";
        ParseDwsErrorResult(strResult, out intErrorID, 
            out strErrorMsg);
        MessageBox.Show
            ("A document workspace error occurred.\r\n" +
            "Error number: " + intErrorID.ToString() + "\r\n" +
            "Error description: " + strErrorMsg,
            "DWS Error", MessageBoxButtons.OK, MessageBoxIcon.Error);
    }
    else
    {
        MessageBox.Show
            ("The folder was successfully deleted.",
            "Delete Folder", MessageBoxButtons.OK,
            MessageBoxIcon.Information);
    }
}
catch (Exception exc)
{
    MessageBox.Show("An exception occurred.\r\n" +
        "Description: " + exc.Message,
        "Exception", MessageBoxButtons.OK, MessageBoxIcon.Error);
}

関連項目

参照

Dws クラス
Dws メンバ
websvcDocumentWorkspace 名前空間