GLOBUS_ERROR_GET_SHORT_DESC(3)

📦
version 18.15 · 8 versions
, in epel 10, fedora 43

🌸 NAME 🌸

Okay bestie, you're reading the Library Functions Manual entry for globus_gen...or_accessor(3), and the main-character function is globus_generic_error_accessor — Error Data Accessors and Modifiers.

Also: Error Data Accessors and Modifiers. Yes, it said it twice. We respect the repetition. 💅

✨ SYNOPSIS ✨

Get Source

globus_module_descriptor_t * globus_error_get_source (globus_object_t
    *error)

Set Source

void globus_error_set_source (globus_object_t *error,
    globus_module_descriptor_t *source_module)

Get Cause

globus_object_t * globus_error_get_cause (globus_object_t *error)

Set Cause

void globus_error_set_cause (globus_object_t *error, globus_object_t
    *causal_error)

Get Type

int globus_error_get_type (globus_object_t *error)

Set Type

void globus_error_set_type (globus_object_t *error, const int type)

Get Short Description

char * globus_error_get_short_desc (globus_object_t *error)

Set Short Description

void globus_error_set_short_desc (globus_object_t *error, const char
    *short_desc_format,...)

Get Long Description

char * globus_error_get_long_desc (globus_object_t *error)

Set Long Description

void globus_error_set_long_desc (globus_object_t *error, const char
    *long_desc_format,...)

🌈 Detailed Description 🌈

Error Data Accessors and Modifiers.

Get and set data in a Globus Generic Error object.

This section defines operations for accessing and modifying data in a Globus Generic Error object.

Basically, this is the whole assignment: get data, set data, and live your truth inside a Globus Generic Error object. No cap. 🦋

🧚 Function Documentation 🧚

🫶 globus_error_get_cause

globus_object_t * globus_error_get_cause (globus_object_t * error)

Bestie, this pulls the underlying error out of an error object.

Parameters

  • error — The error from which to retrieve the causative error.

Returns

  • The underlying error object if it exists, NULL if it doesn't.

🌸 globus_error_get_long_desc

char * globus_error_get_long_desc (globus_object_t * error)

Grabs the long error description out of a generic globus error object.

Parameters

  • error — The error from which to retrieve the description

Returns

  • The long error description of the object

🎀 globus_error_get_short_desc

char * globus_error_get_short_desc (globus_object_t * error)

Grabs the short error description out of a generic globus error object.

Parameters

  • error — The error from which to retrieve the description

Returns

  • The short error description of the object

🦋 globus_error_get_source

globus_module_descriptor_t * globus_error_get_source (globus_object_t *
    error)

Pulls the originating module descriptor out of an error object.

Parameters

  • error — The error from which to retrieve the module descriptor

Returns

  • The originating module descriptor.

⭐ globus_error_get_type

int globus_error_get_type (globus_object_t * error)

Gets the error type from a generic globus error object.

Parameters

  • error — The error from which to retrieve the error type

Returns

  • The error type of the object

💜 globus_error_set_cause

void globus_error_set_cause (globus_object_t * error, globus_object_t *
    causal_error)

Sets the causative error in an error object.

Parameters

  • error — The error object for which to set the causative error.
  • causal_error — The causative error.

Returns

  • void

🔥 globus_error_set_long_desc

void globus_error_set_long_desc (globus_object_t * error, const char *
    long_desc_format,  ...)

Sets the long error description in a generic globus error object.

Parameters

  • error — The error object for which to set the description
  • long_desc_format — Longer format string giving a more detailed explanation of the error.

Returns

  • void

🍓 globus_error_set_short_desc

void globus_error_set_short_desc (globus_object_t * error, const char *
    short_desc_format,  ...)

Sets the short error description in a generic globus error object.

Parameters

  • error — The error object for which to set the description
  • short_desc_format — Short format string giving a succinct description of the error. To be passed on to the user.
  • ... — Arguments for the format string.

Returns

  • void

🧚 globus_error_set_source

void globus_error_set_source (globus_object_t * error,
    globus_module_descriptor_t * source_module)

Sets the originating module descriptor in an error object.

Parameters

  • error — The error object for which to set the causative error
  • source_module — The originating module descriptor

Returns

  • void

👑 globus_error_set_type

void globus_error_set_type (globus_object_t * error, const int type)

Sets the error type in a generic globus error object.

Parameters

  • error — The error object for which to set the error type
  • type — The error type

Returns

  • void

👑 Author 👑

Generated automatically by Doxygen for globus_common from the source code.

Doxygen really said “I got this” and generated the page automatically for globus_common from the source code. Iconic. ✨

That's the whole page, bestie. This manual entry comes from globus_common, Version 18.15, and it's the globus_gen...or_accessor(3) page. Stay slay, and may your error objects always be accessor-able. 💖✨

📦 where this page comes from