searchhelpfilefullpath.cpp File Reference

#include <common.h>
#include <pgm_base.h>
#include <paths.h>
#include <systemdirsappend.h>
#include <trace_helpers.h>
#include <wx/arrstr.h>
#include <wx/log.h>

Go to the source code of this file.

Functions
wxString	SearchHelpFileFullPath (const wxString &aBaseName)
	Return the help file's full path.

Function Documentation

SearchHelpFileFullPath()

wxString SearchHelpFileFullPath

(

const wxString &

aBaseName

)

Return the help file's full path.

Return the full path and name (including extension) of the given KiCad help file. It is expected to be found in a subfolder help/<LANG>/ in one of the system paths. Supported file types are *.html and *.pdf. If no such file is available for the current locale, an attempt to find the English version is made. The search order for <LANG> is: 1) canonical form (e.g., "fr_FR"), 2) short form (e.g., "fr"), and 3) "en".

Parameters

aBaseName

is the name of the help file to search for (without extension).

Returns

the full path and filename if aBaseName is found, else wxEmptyString.

Definition at line 32 of file searchhelpfilefullpath.cpp.

References SEARCH_STACK::AddPaths(), PATHS::GetDocumentationPath(), PGM_BASE::GetLocale(), path, Pgm(), SystemDirsAppend(), and tracePathsAndFiles.

Referenced by COMMON_CONTROL::ShowHelp().