Method

VtePropertiesget_property_string

unstable since: 0.82

Declaration [src]

const char*
vte_properties_get_property_string (
  const VteProperties* properties,
  const char* prop,
  size_t* size
)

Description [src]

Returns the value of a VTE_PROPERTY_STRING property, or NULL if prop is unset, or prop is not a registered property.

Available since: 0.82

Parameters

prop

Type: const char*

A property name.

The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.
size

Type: size_t*

A location to store the string length, or NULL.

The argument will be set by the function.
The argument can be NULL.

Return value

Type: const char*

The property’s value, or NULL.

The returned data is owned by the instance.
The return value can be NULL.
The value is a NUL terminated UTF-8 string.