Load Method (loadValue)

Loads a previously saved state saved by the Save() method.

Declaration Syntax

Visual Basic

Visual C++

bool Load(
	string loadValue
)

Function Load ( _
	loadValue As String _
) As Boolean

bool Load(
	String^ loadValue
)

Parameters

loadValue (String): A single string holding data necessary for this plug-in to reload a previous state.

Return Value

True if the load went successfully, false otherwise.

Remarks

The load method is meant to only be called when recalling a previously saved state. This method differs from the Initialize() method in that it only takes a load string. Where as initialize is required for proper execution in most plug-ins, Load() is really only necessary when recalling a previous state of the plug-in. Load and Save are complementary methods - Load will understand the string returned by Save(). Multiple consecutive loads should also be considered when implementing the Load() method.

Assembly: Chameleon_Plugin (Module: Chameleon_Plugin) Version: 2.0.2.16570 (2.0.2.0)