GetProfileString Method (Editor Object)¶
Retrieves the string value for the specified entry from the Registry or an INI file depending on the EmEditor
settings. nKey Specifies one of the following values to specify a key. eeRegConfig
and eeRegEmEditorPlugin require the pszConfig parameter to specify the key. eeRegCommon HKEY_CURRENT_USER\Software\EmSoft\EmEditor v3\Common or eeCommon.ini\[Common] eeRegRegist HKEY_CURRENT_USER\Software\EmSoft\Regist or eeCommon.ini\[Regist] eeRegLMCommon HKEY_LOCAL_MACHINE\SOFTWARE\EmSoft\EmEditor v3\Common or eeLM.ini\[Common] eeRegLMRegist HKEY_LOCAL_MACHINE\SOFTWARE\EmSoft\Regist or eeLM.ini\[Regist] eeRegConfig HKEY_CURRENT_USER\Software\EmSoft\EmEditor v3\Config\(pszConfig) or eeConfig.ini\[(pszConfig)] eeRegEmEditorPlugins HKEY_CURRENT_USER\Software\EmSoft\EmEditorPlugIns\(pszConfig) or eePlugins.ini\[(pszConfig)] eeRegEmEditorUsers HKEY_CURRENT_USER\Software\EmSoft\EmEditorUsers\(pszConfig) or eeUsers.ini\[(pszConfig)] strConfig Specifies an additional string to specify the key when eeRegConfig, eeRegEmEditorPlugin, or eeRegEmEditorUsers is selected. strEntry Specifies the name of the value to be retrieved. strDefault Specifies the default value in case the value is not found or
cannot be retrieved. This example explains how to retrieve a 64-bit integer value. Supported on EmEditor Professional Version 8.00 or later.¶
[JavaScript]¶
str = editor.GetProfileString( nKey, strConfig, strEntry, strDefault );
[VBScript]¶
str = editor.GetProfileString( nKey, strConfig, strEntry, strDefault )
Parameters¶
Examples¶
[JavaScript]¶
nHigh = 0;
nLow = 0;
s = editor.GetProfileString( eeRegCommon, "", "FindFlag", "0" );
if( s.length == 18 && s.substr( 0, 2 ) == "0x" ) {
nHigh = parseInt( s.substr( 2, 8 ), 16 );
nLow = parseInt( s.substr( 10, 8 ), 16 );
}
Version¶