System.IniFiles.TIniFile.DeleteKey

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure DeleteKey(const Section, Ident: String); override;

C++

virtual void __fastcall DeleteKey(const System::UnicodeString Section, const System::UnicodeString Ident);

Properties

Type Visibility Source Unit Parent
procedure
function
public
System.IniFiles.pas
System.IniFiles.hpp
System.IniFiles TIniFile

Description

Removes an INI file entry for a specified key value.

Call DeleteKey to erase an INI file entry. Section is a string containing the name of an INI file section, and Ident is a string containing the name of the key from for which to set a nil (Delphi) or NULL (C++) value.

This version of DeleteKey is only available if the application is compiled for Windows.

Note: Attempting to delete a key in a nonexistent section or attempting to delete a nonexistent key are not errors. In these cases, DeleteKey does nothing.

See Also