ssCore.INIFile.deleteKey

Delete the specified key (and value) from the specified section.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

path - A fully qualified path to the INI file. This parameter supports monikers.

section - The name of the section containing the key to be deleted.

key - Name of the key to be deleted.


Output Parameters:

No output parameters.


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.INIFile.deleteKey( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.INIFile.deleteKey( paramsObject );


Notes:

Do not include the enclosing square brackets ("[" and "]") in the section name argument.

                

Examples:

ssCore.INIFile.deleteKey({path:"startdir://settings.ini", section:"Window", key:"width"});