PersonalizationProvider.LoadPersonalizationBlobs(WebPartManager, String, String, Byte[], Byte[]) Method

Definition

When overridden in a derived class, loads raw personalization data from the underlying data store.

protected:
 abstract void LoadPersonalizationBlobs(System::Web::UI::WebControls::WebParts::WebPartManager ^ webPartManager, System::String ^ path, System::String ^ userName, cli::array <System::Byte> ^ % sharedDataBlob, cli::array <System::Byte> ^ % userDataBlob);
protected abstract void LoadPersonalizationBlobs (System.Web.UI.WebControls.WebParts.WebPartManager webPartManager, string path, string userName, ref byte[] sharedDataBlob, ref byte[] userDataBlob);
abstract member LoadPersonalizationBlobs : System.Web.UI.WebControls.WebParts.WebPartManager * string * string * Byte[] * Byte[] -> unit

Parameters

webPartManager
WebPartManager

The WebPartManager managing the personalization data.

path
String

The path for personalization information to be used as the retrieval key.

userName
String

The user name for personalization information to be used as the retrieval key.

sharedDataBlob
Byte[]

The returned data for the Shared scope.

userDataBlob
Byte[]

The returned data for the User scope.

Remarks

Classes that derive from PersonalizationProvider and implement this method should use the webPartManager, path, and username parameters as retrieval keys. Regardless of how the data is stored in the data store (some data stores might perform some type of intelligent storage), the personalization data must be returned as a packed set of bytes in two arrays. The returned data must conform to the following rules:

  • The data for the Shared scope must always be returned in the sharedDataBlob parameter.

  • Depending on the key values, User data is returned in the userDataBlob parameter. A non-null value for the userName parameter indicates that User data should also be retrieved.

A personalization provider that derives from PersonalizationProvider and implements this method can optimize interactions with its data store by retrieving all personalization data in one round trip, as opposed to retrieving Shared and User data in two separate round trips.

Applies to