Function

Arrows3_initialize

since: 7.0.0

Declaration [src]

gboolean
garrow_s3_initialize (
  GArrowS3GlobalOptions* options,
  GError** error
)

Description [src]

Normally, you don’t need to call this function because the S3 APIs are initialized with the default options automatically. If you want to call this function, you must call this function before you use any GArrowS3FileSystem related APIs.

Available since: 7.0.0

Parameters

options

Type: GArrowS3GlobalOptions

Options to initialize the S3 APIs.

The argument can be NULL.
The data is owned by the caller of the function.
error

Type: GError **

The return location for a recoverable error.

The argument can be NULL.
If the return location is not NULL, then you must initialize it to a NULL GError*.
The argument will left initialized to NULL by the function if there are no errors.
In case of error, the argument will be set to a newly allocated GError; the caller will take ownership of the data, and be responsible for freeing it.

Return value

Type: gboolean

TRUE on success, FALSE on error.