Windows SharePoint Services Provider API

Article
04/19/2010

This section provides the details of the application programming interface (API) for the Microsoft Windows SharePoint Services Provider included with the Microsoft Provisioning System (MPS) in the .

Overview

The procedures in Windows SharePoint Provider namespace help the Service Provider to integrate Windows SharePoint Services with the other services provisioned by MPS.

The Windows SharePoint Services Provider will provide functionality through MPS that will enable day to day operations in Windows SharePoint Services after the Server has been initially configured.

Important

Windows SharePoint Provider namespace occasionally demands that Extensible Markup Language (XML) elements be in exactly the order shown in the samples, and may produce unpredictable failures due to out-of-order elements.

Important

The SharePoint Provider namespace fails untrusted requests that do not have associated credentials. The provider requires that the sendCredentials parameter be set to true when the provider and the client are on separate servers.

Public Methods

Public Method	Description
SharePoint Provider::AddGroup	Adds a cross-site group to Windows SharePoint Services. Fails if the group already exists. Rollback deletes the group.
SharePoint Provider::AddGroupToRole	Adds a cross-site group to the specified role (site group). This method implements rollback.
SharePoint Provider::AddUsersToGroup	Adds one or more user accounts to the specified cross-site group. This call implements rollback.
SharePoint Provider::AddUsersToRole	Adds one or more user accounts to the specified site group. This call implements rollback.
SharePoint Provider::CreateSite	Creates and enables a Microsoft SharePoint site on the specified server.
SharePoint Provider::DeleteSite	Removes a Microsoft SharePoint site of the type create with CreateSite above.
SharePoint Provider::EnumerateFolder	Returns information about the files and folders within a folder on a SharePoint site.
SharePoint Provider::GetAllSubWebs	Returns the titles and URLs of all sites within the current site collection.
SharePoint Provider::GetAllUsersFromWeb	Returns information about the collection of users for the current site.
SharePoint Provider::GetAttachments	Returns the URLs for all attachments to a specified item in a SharePoint list.
SharePoint Provider::GetGroupInfo	Returns information about one or more specified cross-site groups in the current site collection.
SharePoint Provider::GetGroupsFromRole	Returns information about the collection of cross-site groups assigned to the specified site group.
SharePoint Provider::GetGroupsFromSite	Returns information about the collection of cross-site groups for the current site collection.
SharePoint Provider::GetGroupsFromUser	Returns information about the collection of cross-site groups of which the specified user is a member.
SharePoint Provider::GetGroupsFromWeb	Returns information about the collection of cross-site groups for the current site.
SharePoint Provider::GetLanguages	Returns a list of the SharePoint sites that exist under the specified virtual server.
SharePoint Provider::GetList	Returns metadata from the specified SharePoint list.
SharePoint Provider::GetLists	Returns information about all the lists in the current SharePoint site.
SharePoint2007Provider::GetListTemplates	Returns the collection of list template definitions for the current site.
SharePoint Provider::GetPermissions	Returns the collection of permissions for a site or list.
SharePoint Provider::GetRoleInfo	Returns information about the specified collection of site groups for the current site.
SharePoint Provider::GetRolesFromGroup	Returns information about the collection of site groups of which the specified cross-site group is a member.
SharePoint Provider::GetRolesFromUser	Returns information about the collection of site groups of which the specified user is a member.
SharePoint Provider::GetRolesFromWeb	Returns information about the collection of site groups for the current site.
SharePoint Provider::GetSite	Returns site metadata, information about the subsites in the current site collection, and information about the cross-site groups on the site and about the users who are members of each group.
SharePoint Provider::GetSiteAndWeb	Returns the absolute URL of a subsite and the absolute URL of its top-level parent site based on the specified site URL.
SharePoint Provider::GetSiteTemplates	Returns information about the collection of site definitions and site templates on the virtual server.
SharePoint Provider::GetUserInfo	Returns information about a collection of one or more users based on the specified user names.
SharePoint Provider::GetUserLoginFromEmail	Returns one or more user names based on the specified e-mail address.
SharePoint Provider::GetUsersFromRole	Returns information about the collection of users in the specified site group.
SharePoint Provider::RemoveUsersFromSite	Removes the specified users from the current site collection. This call does not implement rollback. Use RemoveUserFromGroup or RemoveUserFromRole instead.
SharePoint Provider::RemoveUserFromWeb	Removes the specified user from the current site. This call does not implement rollback. Use RemoveUserFromGroup or RemoveUserFromRole instead.
SharePoint Provider::GetWeb	Returns site and list metadata, as well as information about the users and site groups for the current SharePoint site.
SharePoint Provider::GetWebs	Returns properties of a collection of sites (for example, name, description, and theme).
SharePoint Provider::QueryListItems	Performs a query against the specified SharePoint list.
SharePoint Provider::RefreshConfigCache	Refreshes the configuration cache for the virtual server.
SharePoint Provider::RemoveGroup	Removes the specified cross-site group from the current site collection.
SharePoint Provider::RemoveGroupFromRole	Removes a cross-site group from the specified site group. This method implements rollback.
SharePoint Provider::RemoveRole	Removes the specified site group from the current site. Rollback is not supported.
SharePoint Provider::RemoveUsersFromGroup	Removes the users with the specified user names from the cross-site group. This call implements rollback.
SharePoint Provider::RemoveUsersFromRole	Removes the users with the specified user names from the specified site group. This call implements rollback.
SharePoint Provider::RemoveUsersFromSite	Removes the specified users from the current site collection. This call does not implement rollback. Use RemoveUserFromGroup or RemoveUserFromRole instead.
SharePoint Provider::RemoveUserFromWeb	Removes the specified user from the current site. This call does not implement rollback. Use RemoveUserFromGroup or RemoveUserFromRole instead.
SharePoint Provider::SetListPermissions	Adds, modifies, or removes permissions to the list for the specified collection of existing users, site groups, and/or cross-site groups.
SharePoint Provider::UpdateWebPermisions	Modifies site-level permissions for the specified collection of existing site groups.
SharePoint Provider::UpdateGroupInfo	Updates information for the specified cross-site group. The underlying Windows SharePoint Services API does not provide a mechanism for updating any subset of these parameters, so all of them must be supplied. This method supports rollback.
SharePoint Provider::UpdateRoleInfo	Updates information for the specified site group. The underlying Windows SharePoint Services API does not provide a mechanism for updating any subset of these parameters, so all of them must be supplied. This method supports rollback.
SharePoint Provider::UpdateUserInfo	Updates information for the specified user. The underlying Windows SharePoint Services API does not provide a mechanism for updating any subset of these parameters, so all of them must be supplied. This method supports rollback.
SharePoint Provider::WebUrlFromPageUrl	Returns the URL of the parent site for the specified page URL.

Applies To

Hosted Messaging and Collaboration version 3.5
Hosted Messaging and Collaboration version 3.0
Windows-based Hosting version 4.5
Windows-based Hosting version 4.0
Windows-based Hosting version 3.5
Windows-based Hosting for Applications version 1.0

Windows SharePoint Services Provider API

Applies To

Additional resources