メインコンテンツへ移動

キーバリューをコピーする (LCC.kvdb.dict.copy_value)

宣言​

ok, old_value_or_err = LCC.kvdb.dict.copy_value(src_name, src_key, dst_name?, dst_key?, timeout?)

引数​

  • src_name
    文字列。コピー元の辞書名です(空文字列は不可、最大 256 バイト)
  • src_key
    文字列。コピー元のキー名です(有効な UTF-8 の空でない文字列)
  • dst_name
    任意の文字列。コピー先の辞書名です。既定ではコピー元と同じです(空文字列は不可、最大 256 バイト)
  • dst_key
    任意の文字列。コピー先のキー名です。既定ではコピー元のキー名と同じです(有効な UTF-8 の空でない文字列)
  • timeout
    任意の数値。リクエストのタイムアウト(秒)です。既定値は 60 です

戻り値​

  • ok
    ブール値。コピーに成功した場合は true、失敗した場合は false を返します
  • old_value_or_err
    文字列または nil。成功時はコピー先にあった元の値(存在しなければ nil)、失敗時はエラーの説明です

説明​

値をコピー先のキーへコピーします。コピー元のキーは変更されません。
コピー元とコピー先が完全に同じ場合は、元の値を読み取る操作と同じになり、true, 元の値 を返します。
コピー元のキーが見つからない場合は false を返します。

例​

local ok, old = LCC.kvdb.dict.copy_value("テンプレート", "既定設定", "ユーザー設定", "既定設定")
if not ok then
error(old)
end