方法

GioFileset_display_name

声明 [源]

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

描述 [源]

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

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

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

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

如果cancellable不是NULL,则可以从其他线程触发可取消对象来取消操作。如果操作被取消,将返回错误G_IO_ERROR_CANCELLED

参数

display_name

类型: const char*

一个字符串。

数据由方法的调用者拥有。
该值是空终止的UTF-8字符串。
cancellable

类型: GCancellable

可选的GCancellable对象,NULL忽略。

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

类型: GError **

用于可恢复错误的返回位置。

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

返回值

类型: GFile

A GFile指定file被重命名为什么,或者在出错时返回NULL。使用g_object_unref()释放返回的对象。

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