set_identifier


Description:

[ Version ( since = "1.31.14" ) ]
public bool set_identifier (string identifier) throws Error

set the handle identifier

This is an informative string which the caller may optionally set in the handle. It is printed in various places, allowing the current handle to be identified in debugging output.

One important place is when tracing is enabled. If the identifier string is not an empty string, then trace messages change from this:

<![CDATA[libguestfs: trace: get_tmpdir]]>

<![CDATA[libguestfs: trace: get_tmpdir = "/tmp"]]>

to this:

<![CDATA[libguestfs: trace: ID: get_tmpdir]]>

<![CDATA[libguestfs: trace: ID: get_tmpdir = "/tmp"]]>

where ID is the identifier string set by this call.

The identifier must only contain alphanumeric ASCII characters, underscore and minus sign. The default is the empty string.

See also set_program, set_trace, get_identifier.

Parameters:

this

A GuestfsSession object

Returns:

true on success, false on error