ScnLib_DeleteSettings()

ScnLib_DeleteSettingsA/W()

Std EditionPro EditionMax EditionUltra Edition
C++ __declspec(dllimport) BOOL __stdcall ScnLib_DeleteSettingsA(HKEY hKey, LPCSTR pcszSubKey);
__declspec(dllimport) BOOL __stdcall ScnLib_DeleteSettingsW(HKEY hKey, LPCWSTR pcwszSubKey);
C# [DllImport("ScnLib.dll", CharSet = CharSet.Unicode)] public static extern bool ScnLib_DeleteSettingsW(IntPtr RegKey, string SubKey);
Basic Public Declare Unicode Function ScnLib_DeleteSettingsW Lib "ScnLib.dll" (ByVal RegKey As IntPtr, ByVal SubKey As String) As Boolean
Delphi function ScnLib_DeleteSettingsA(RegKey: THandle; const SubKey: PAnsiChar): LongBool; stdcall; external 'ScnLib.dll'; function ScnLib_DeleteSettingsW(RegKey: THandle; const SubKey: PWideChar): LongBool; stdcall; external 'ScnLib.dll';
  • Description
    Delete the SDK settings saved in the Windows registry.

  • Parameters
    • RegKey [in]
      A handle to a currently open key or any of the following predefined keys:
      • HKEY_CURRENT_USER
      • HKEY_LOCAL_MACHINE
      On systems with Windows User Account Control (UAC) activated (which is the default setting from Windows Vista onwards), setting HKEY_LOCAL_MACHINE as the RegKey requires your program to have administrator privileges to delete entries from this registry key.
    • SubKey [in]
      The sub-key under the RegKey from which you wish to delete the SDK settings in the Windows registry. To delete from the SDK's default sub-key, pass a zero value or an empty string.
  • Return Value
    If the SDK settings are deleted successfully, the return value is TRUE. Otherwise, the return value is FALSE.

  • Remarks
    Use this function to delete the SDK settings previously saved in the Windows registry through ScnLib_SaveSettingsA/W(). The SDK offers numerous settings that can be programmatically modified to suit your needs. This function is typically used to reset the SDK settings back to their default values.

  • See Also
    ScnLib_LoadSettingsA/W()
    ScnLib_SaveSettingsA/W()
    ScnLib_ConfigureSettings()

Try the SDK for FREE SDK APIs overview