ResourceFolder

OutputVar := MfEnvironment.Instance.ResourceFolder

Value

Var String

Gets

Gets the current resource folder for Mini-Framework as var string.

Throws

Throws MfNotSupportedException if attempt is made to set value.

Returns

A var of string containing the path to the current resource folder

Remarks

Read-only Property
ResourceFolder is checked for in several locations and returns the first valid found location.
The search locations are as follows

There is an option to set a Super Global in your project that takes the highest priority for the location of Mini-Framework resources.

To use the Super Global option set a Global var named MfResourceFolder and set it to the location of the resources.

#NoEnv
#SingleInstance Force
#NoTrayIcon
#KeyHistory 0
SetBatchLines -1
ListLines, Off
SendMode Input ; Forces Send and SendRaw to use SendInput buffering for speed.
SetTitleMatchMode, 3 ; A window's title must exactly match WinTitle to be a match.
SetWorkingDir, %A_ScriptDir%

; Include Mini-Framework 0.4.0.5
#Include <inc_mf_0_4>
; set super global to local resources manually
Global MfResourceFolder := "C:\Program Files\AutoHotkey\Lib\Mini_Framwork\0.4\System\Resource"

If Super Global MfResourceFolder is not set ( default ) or not found then resources search for the first found location in the following order

{Script Folder}\Lib\Mini_Framwork\0.4\System\Resource
{Script Folder}\Lib\System\Resource
{Script Folder}\Lib\Resource
{Script Folder}\Lib\Resources
{Script Folder}
{Program Files}\AutoHotkey\Lib\Mini_Framwork\0.4\System\Resource
Resource Path set by Mini-Framework installer usually the same as the previous line
{Path set by AutoHotkey installer}\lib\Mini_Framwork\0.4\System\Resource
{My Documents}\AutoHotkey\Lib\Mini_Framwork\0.4\System\Resource

Note:

You may get a error similar to the following when you run your script. This error will occur if the resource folder can not be located.

Unable to locate core Resource File.
Try placing the core resource file (Resource_Core_en-US.dll) in a sub-folder named Resource for the current running script.
Expected Resource\Resource_Core_en-US.dll

This can be solved by placing the resources in a search location as shown above or by setting the Super Global MfResourceFolder to the location of the resources folder as show above.

Users of AutoHotkey Studio (AHK Studio) may run in to an issue when running scripts inside of AHK Studio. You may get a resource error message even though Mini-Framework has been installed.

This error occurs when The resource file can not be located in the folder search locations listed above and an attempt is made to read the registry to search for the location of the resource folder. AHK Studio may not allow access to the registry with default settings.

In most case you will not get this error but if you do you can fix one of two ways.

• Set AhK Studio to Run as Administrator (Alt+m Then Type: run as admin)
• Set the Super Global MfResourceFolder to the location of the resources as demonstrated above.

If Super Global MfResourceFolder option is set and the resources can not be located in that location then search continues to look for resources in other valid locations. The search stops at the first location resources are found.