mySobek Home   |   Help
Skip Navigation Links.
Expand <a href='http://sobekrepository.org/sobekcm' title='Sobek home page'>Project Home</a>Project Home
Expand <a href='http://sobekrepository.org/help' title='Online user help'>User Help</a>User Help
Expand <a href='http://sobekrepository.org/sobekcm/technical' title='Sobek home page'>Technical Help</a>Technical Help
Expand <a href='http://sobekrepository.org/software' title='Center for downloading all SobekCM-related software'>Download Center</a>Download Center
Training Videos
Collapse <a href='http://sobekrepository.org/codehelp' title='Details on each of the different classes, interfaces, properties, etc..'>Code Details</a>Code Details
MISSING BANNER
Code Details >> Library >> SobekCM_Assistant >> Get_Public_User_Folder

SobekCM_Assistant.Get_Public_User_Folder Method



Retrieve the public user folder information and browse by user folder id


Namespace: SobekCM.Library
Assembly: SobekCM_Library (in SobekCM_Library.dll) Version: 4.10.0.0 (4.10.0.0)

Syntax

C#
public bool Get_Public_User_Folder(
	int UserFolderID,
	int ResultsPage,
	Custom_Tracer Tracer,
	out Public_User_Folder Folder_Info,
	out Search_Results_Statistics Complete_Result_Set_Info,
	out List<iSearch_Title_Result> Paged_Results
)

Parameters

UserFolderID
Type: System..::..Int32
Primary key for the public user folder to retrieve
ResultsPage
Type: System..::..Int32
Which page of results to return ( one-based, so the first page is page number of one )
Tracer
Type: SobekCM.Tools..::..Custom_Tracer
Trace object keeps a list of each method executed and important milestones in rendering
Folder_Info
Type: SobekCM.Core.Users..::..Public_User_Folder%
[OUT] Information about this public user folder including name and owner
Complete_Result_Set_Info
Type: SobekCM.Core.Results..::..Search_Results_Statistics%
[OUT] Information about the entire set of results
Paged_Results
Type: System.Collections.Generic..::..List<(Of <(<'iSearch_Title_Result>)>)>%
[OUT] List of search results for the requested page of results

Return Value

Type: Boolean
TRUE if successful, otherwise FALSE

Remarks

This attempts to pull the objects from the cache. If unsuccessful, it builds the objects from the database and hands off to the CachedDataManager to store in the cache

See Also



Version 4.10.0 ( last generated Monday, March 7, 2016 )