ResetResources Method

ResourceMgr ResetResources Method

CleanCode C# Libraries v1.2.03 API

Resets externalized file resources for a specific control.

Namespace: CleanCode.IO
Assembly: CleanCode (in CleanCode.dll) Version: 1.2.3.0 (1.2.03)

Syntax

public static Collection<string> ResetResources(
	string filePattern,
	ref bool resetResources
)

public static Collection<string> ResetResources(
	string filePattern,
	ref bool resetResources
)

Public Shared Function ResetResources ( _
	filePattern As String, _
	ByRef resetResources As Boolean _
) As Collection(Of String)

Public Shared Function ResetResources ( _
	filePattern As String, _
	ByRef resetResources As Boolean _
) As Collection(Of String)

public:
static Collection<String^>^ ResetResources(
	String^ filePattern, 
	bool% resetResources
)

public:
static Collection<String^>^ ResetResources(
	String^ filePattern, 
	bool% resetResources
)

Parameters

filePattern: Type: System String
The file pattern.

resetResources: Type: System Boolean
if set to false resets resources.

Return Value

A collection of filenames that were deleted.

Remarks

This is typically called when a parent application detects a new version has been installed and wants to refresh any file resources that have been externalized from prior versions. The process of resetting file resources just deletes them from the file system. Your application code must then recognize that a resource needs to be written to the file system on first use. The Boolean parameter allows for multiple instances of a class to call this method yet only the first one will actually reset the resources (since external resources are by definition class resources).