Dws.GetDwsData - Méthode

Renvoie des informations sur un site d'espace de travail de Document et les listes qu'il contient.

Espace de noms :  WebSvcDWS
Assembly :  STSSOAP (dans STSSOAP.dll)

Syntaxe

'Déclaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/dws/GetDwsData", RequestNamespace := "https://schemas.microsoft.com/sharepoint/soap/dws/",  _
    ResponseNamespace := "https://schemas.microsoft.com/sharepoint/soap/dws/",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Function GetDwsData ( _
    document As String, _
    lastUpdate As String _
) As String
'Utilisation
Dim instance As Dws
Dim document As String
Dim lastUpdate As String
Dim returnValue As String

returnValue = instance.GetDwsData(document, _
    lastUpdate)
[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/dws/GetDwsData", RequestNamespace = "https://schemas.microsoft.com/sharepoint/soap/dws/", 
    ResponseNamespace = "https://schemas.microsoft.com/sharepoint/soap/dws/", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public string GetDwsData(
    string document,
    string lastUpdate
)

Paramètres

  • document
    Type : System.String

    String. L'URL sur site d'un document dans une bibliothèque de documents dans le site espace de travail de Document. par exemple, « Shared Documents /document_name.doc. » Cet argument fournit le contexte pour la liste de Documents a renvoyé par la méthode GetDwsData .

  • lastUpdate
    Type : System.String

    String. La valeur LastUpdate est renvoyée dans les résultats d'un appel précédent à la méthode GetDwsData ou GetDwsMetadata , ou une chaîne vide. Si une liste dans le site espace de travail de Document n'a pas changé depuis lastUpdate, la méthode GetDwsData renvoie la valeur « aucune modification » à la place des données de la liste pour des raisons de performances.

Valeur renvoyée

Type : System.String

Une chaîne qui est un code XML du document fragment qui contient les informations suivantes :

  • Title

  • LastUpdate

  • Utilisateur

  • Membres

  • Intervenants

  • Listes (tâches, les Documents, les liens)

Exceptions

Exception Condition
[DWSError.NoAccess(3)]

Peut être retournée par la méthode GetDwsMetaData . Indique que l'utilisateur ne dispose pas de droits suffisants.

[DWSError.NoAccess(3)]

Peut être retournée par la méthode GetDwsData dans les résultats qu'elle renvoie se rapportant aux listes sur le site d'espace de travail de Document. Indique que l'utilisateur ne dispose pas de droits suffisants.

[DwsError.ListNotFound(7)]

Peut être retournée par la méthode GetDwsData dans les résultats qu'elle renvoie se rapportant aux listes sur le site d'espace de travail de Document. Indique la liste spécifiée n'existe pas.

[DwsError.TooManyItems(8)]

Peut être retournée par la méthode GetDwsData dans les résultats qu'elle renvoie se rapportant aux listes sur le site d'espace de travail de Document. Indique la liste spécifiée contient plus de 99 articles.

Remarques

La méthode GetDwsData renvoie des informations générales sur le site espace de travail de Document, ainsi que ses membres, les documents, les liens et les tâches.

Exemples

L'exemple de code suivant retourne des informations à partir d'un site espace de travail de Document à l'aide de la méthode GetDwsData . L'exemple spécifie un document partagé en tant que contexte pour la liste de Documents et lance Internet Explorer pour afficher les résultats de la mise en forme XML. Pour plus d'informations sur le texte intégral des fonctions d'assistance utilisées dans cet exemple, consultez la méthode CanCreateDwsUrl .

Try
    Dim strResult As String
    strResult = dwsWebService.GetDwsData("Shared 
        Documents/document_name.doc", "")
    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
        Dim strOutputFile As String = "C:\GetDwsData.xml"
        Dim tw As System.IO.TextWriter
        tw = System.IO.File.CreateText(strOutputFile)
        tw.WriteLine(strResult)
        tw.Close()
        Dim ieXMLViewer As System.Diagnostics.Process
        ieXMLViewer = New System.Diagnostics.Process()
        ieXMLViewer.Start("iexplore.exe", "file://" & strOutputFile)
    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.GetDwsData("Shared 
        Documents/document_name.doc", "");
    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
    {
        string strOutputFile = "C:\\GetDwsData.xml";
        System.IO.TextWriter tw = 
            System.IO.File.CreateText(strOutputFile);
        tw.WriteLine(strResult);
        tw.Close();
        System.Diagnostics.Process.Start("iexplore.exe", "file://" + 
            strOutputFile);
    }
}
catch (Exception exc)
{
    MessageBox.Show("An exception occurred.\r\n" +
        "Description: " + exc.Message,
        "Exception", MessageBoxButtons.OK, MessageBoxIcon.Error);
}

Voir aussi

Référence

Dws classe

Dws - Membres

WebSvcDWS - Espace de noms