虚方法

GioFileset_display_name

声明 [src]

GFile*
set_display_name (
  GFile* file,
  const char* display_name,
  GCancellable* cancellable,
  GError** error
)

描述 [src]

将文件重命名为指定的显示名。

如果可能,将显示名从 UTF-8 转换为目标的正确编码,然后将文件重命名为此显示名。

如果要在用户界面中实现重命名操作,应将编辑名称(G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME)作为重命名小部件的初始值使用,然后再将编辑后的结果传递给 g_file_set_display_name()。

成功时返回转换后的结果文件名。

如果 cancellable 不是 NULL,则可以在另一个线程中触发可取消对象以取消操作。如果操作被取消,将返回错误 G_IO_ERROR_CANCELLED

参数

display_name

类型: const char*

一个字符串。

数据由方法的调用者拥有。
该值是一个以 NUL 结尾的 UTF-8 字符串。
cancellable

类型: GCancellable

可选的 GCancellable 对象,NULL 则忽略。

该参数可以是 NULL
数据由方法的调用者拥有。
error

类型: GError **

一个可恢复错误的返回位置。

该参数可以是 NULL
如果返回位置不是 NULL,则必须将其初始化为 NULL GError*
如果没有错误,虚拟函数将保留参数的初始化为 NULL
如果出错,将参数设置为新分配的 GError;调用者将拥有数据,并负责释放它。

返回值

类型: GFile

一个 GFile,指定已重命名的文件,或者如果有错误,则返回 NULL。使用 g_object_unref() 释放返回的对象。

方法的调用者拥有返回的数据,并负责释放它。