Dws.FindDwsDoc Method

Returns the absolute URL of a document listed in the documents parameter of a previous call to the CreateDws method.

Namespace:  [DWS Web service]
Web service reference: http://Site/_vti_bin/DWS.asmx

Syntax

'Declaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/dws/FindDwsDoc", RequestNamespace := "https://schemas.microsoft.com/sharepoint/soap/dws/",  _
    ResponseNamespace := "https://schemas.microsoft.com/sharepoint/soap/dws/",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Function FindDwsDoc ( _
    id As String _
) As String
'Usage
Dim instance As Dws
Dim id As String
Dim returnValue As String

returnValue = instance.FindDwsDoc(id)

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

Parameters

• id
  Type: System.String

  String. The globally unique identifier (GUID) used to identify the document. This GUID is stored as a part of the _SharedFileIndex custom property for the document.

Return Value

Type: System.String
A string that returns the absolute URL of the document in the format <Result>{document url}</Result> when successful.

Exceptions

Exception	Condition
[HTTPerrorcode401]	The user does not have sufficient rights.
[DWSError.ItemNotFound(5)]	Could not find the specified item.

Remarks

The FindDwsDoc method returns the absolute URL of a document listed in the documents argument of a previous call to the CreateDws method. The FindDwsDoc method locates the document by using the GUID previously passed to the CreateDws method. This GUID is stored as part of the _SharedFileIndex custom property for the document.

When the user does not have sufficient rights, the HTTP error response raises an exception.

Microsoft Office Outlook uses the FindDwsDoc method in the context of its Shared Attachments feature.

See Also

Reference

Dws Class

Dws Members

DWS Web Service