PublishingService.GetAllFriendlyUrls method

Returns a collection of FriendlyUrl objects —one for each friendly URL and its associated properties in the specified SPWeb.

Namespace:  Microsoft.SharePoint.Publishing.WebServices
Assembly:  Microsoft.SharePoint.Publishing (in Microsoft.SharePoint.Publishing.dll)

Syntax

'Declaration
<WebMethodAttribute> _
Public Function GetAllFriendlyUrls ( _
    siteId As Guid, _
    webId As Guid, _
    ByRef pagingToken As String _
) As FriendlyUrl()
'Usage
Dim instance As PublishingService
Dim siteId As Guid
Dim webId As Guid
Dim pagingToken As String
Dim returnValue As FriendlyUrl()

returnValue = instance.GetAllFriendlyUrls(siteId, _
    webId, pagingToken)

[WebMethodAttribute]
public FriendlyUrl[] GetAllFriendlyUrls(
    Guid siteId,
    Guid webId,
    ref string pagingToken
)

Parameters

• siteId
  Type: System.Guid

  ID of the SPSite object.

• webId
  Type: System.Guid

  ID of the SPWeb object.

• pagingToken
  Type: System.String

  There may be a large number of results that need to be returned. In that case, the results need to be chunked into pages. The pagingToken parameter is an opaque token that SharePoint Server returns to the caller of the PublishingService web service. The caller keeps calling the GetFriendlyUrlBasedWebs(System.Guid,System.String@) method with the pagingToken parameter, and SharePoint Server continues to update the paging token until the last page is reached. When the last page is reached, SharePoint Server sets it to an empty string. In the first call, the caller is supposed to set the pagingToken parameter to an empty string.

Return value

Type: []

Remarks

The call is paged by using the page token so that in any given call SharePoint Server return only one page (= PageSize) number of entries. If there are more, then the subsequent calls will have to be made by using this method with a new pagingToken.

See also

Reference

PublishingService class

PublishingService members

Microsoft.SharePoint.Publishing.WebServices namespace