GLib-2.0 ▶ GLib ▶ Dir

constructor

• new Dir(path: string, flags: number): GLib.Dir

  Parameters

  • path: string
  • flags: number

  Returns GLib.Dir

Static$gtype

close

• close(): void

  Closes the directory immediately and decrements the reference count.

  Once the reference count reaches zero, the GLib.Dir structure itself will be freed. Prior to GLib 2.80, GLib.Dir was not reference counted.

  It is an error to call any of the GLib.Dir methods other than GLib.Dir.ref and GLib.Dir.unref on a GLib.Dir after calling GLib.Dir.close on it.

  Returns void

read_name

• read_name(): string

  Retrieves the name of another entry in the directory, or null. The order of entries returned from this function is not defined, and may vary by file system or other operating-system dependent factors.

  null may also be returned in case of errors. On Unix, you can check errno to find out if null was returned because of an error.

  On Unix, the '.' and '..' entries are omitted, and the returned name is in the on-disk encoding.

  On Windows, as is true of all GLib functions which operate on filenames, the returned name is in UTF-8.

  Returns string

  The entry's name or null if there are no more entries. The return value is owned by GLib and must not be modified or freed.

ref

• ref(): GLib.Dir

  Increment the reference count of dir.

  Returns GLib.Dir

  the same pointer as dir

rewind

• rewind(): void

  Resets the given directory. The next call to g_dir_read_name() will return the first entry again.

  Returns void

unref

• unref(): void

  Decrements the reference count of dir.

  Once the reference count reaches zero, the directory will be closed and all resources associated with it will be freed. If GLib.Dir.close is called when the reference count is greater than zero, the directory is closed but the GLib.Dir structure will not be freed until its reference count reaches zero.

  It is an error to call any of the GLib.Dir methods other than GLib.Dir.ref and GLib.Dir.unref on a GLib.Dir after calling GLib.Dir.close on it.

  Returns void

Staticmake_tmp

• make_tmp(tmpl?: string): string

  Creates a subdirectory in the preferred directory for temporary files (as returned by g_get_tmp_dir()).

  tmpl should be a string in the GLib file name encoding containing a sequence of six 'X' characters, as the parameter to g_mkstemp(). However, unlike these functions, the template should only be a basename, no directory components are allowed. If template is null, a default template is used.

  Note that in contrast to g_mkdtemp() (and mkdtemp()) tmpl is not modified, and might thus be a read-only literal string.

  Parameters

  • Optionaltmpl: string

    Template for directory name, as in g_mkdtemp(), basename only, or null for a default template

  Returns string

Staticopen

• open(path: string, flags: number): GLib.Dir

  Parameters

  • path: string
  • flags: number

  Returns GLib.Dir