system.deletePreferences()

类型 函数
system.*
返回值 布尔值
修订 版本 2024.3703
关键词 系统偏好设置, deletePreferences
另请参见 system.getPreference()
system.setPreferences()

概述

从存储中删除偏好设置。

如果**所有**给定的偏好设置都已成功删除并且不再存在于存储中,则返回 `true`。如果请求的偏好设置在存储中不存在,则仍然将其视为已成功删除。

如果至少有一个给定的偏好设置未能从存储中删除,则返回 `false`。

陷阱

语法

system.deletePreferences( category, preferenceNames )
category (必填)

字符串. 指示应访问系统上的哪一组偏好设置。目前,仅支持 `“app”` 类别 — 这是由 Corona 应用程序开发者定义的应用程序的自定义偏好设置。

preferenceNames (必填)

数组. 一个 字符串 数组,指示要从存储中删除的唯一偏好设置名称。

示例

-- Write this app's custom preferences to storage
local appPreferences =
{
    myBoolean = true,
    myNumber = 123.45,
    myString = "Hello World"
}
system.setPreferences( "app", appPreferences )

-- Sometime later, delete the preferences that were written to storage
system.deletePreferences( "app", { "myBoolean", "myNumber", "myString" } )