SPFolderHierarchy.TryGetFolderByUrl method (SPWeb, String, Boolean, SPFolder)
TryGetFolderByUrl Gets a folder by the server-relative url.
Namespace: Microsoft.Office.Server.Utilities
Assembly: Microsoft.Office.Server (in Microsoft.Office.Server.dll)
Syntax
'Declaration
Public Shared Function TryGetFolderByUrl ( _
web As SPWeb, _
folderUrl As String, _
fCheckIfExists As Boolean, _
<OutAttribute> ByRef folder As SPFolder _
) As Boolean
'Usage
Dim web As SPWeb
Dim folderUrl As String
Dim fCheckIfExists As Boolean
Dim folder As SPFolder
Dim returnValue As Boolean
returnValue = SPFolderHierarchy.TryGetFolderByUrl(web, _
folderUrl, fCheckIfExists, folder)
public static bool TryGetFolderByUrl(
SPWeb web,
string folderUrl,
bool fCheckIfExists,
out SPFolder folder
)
Parameters
- web
Type: Microsoft.SharePoint.SPWeb
- folderUrl
Type: System.String
- fCheckIfExists
Type: System.Boolean
- folder
Type: Microsoft.SharePoint.SPFolder
Return value
Type: System.Boolean
Returns Boolean.
Remarks
We don't actually check whether the folder exists unless requested. Otherwise, we just return whether we have a valid folder object.