System.IniFiles.TCustomIniFile.DeleteKey

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure DeleteKey(const Section, Ident: String); virtual; abstract;

C++

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

Properties

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

Description

Erases the data value associated with an ini file entry.

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

Note: Attempting to erase a data value in a nonexistent section or attempting to erase data from a nonexistent key are not errors. In these cases, DeleteKey creates the section and key and sets its initial value to an empty value.

See Also