Skip to content

Commit

Permalink
Clarify documentation for H5CX_get_data_transform (#4580)
Browse files Browse the repository at this point in the history
* Correct comment for H5CX_get_data_transform

* Document why data transform ctx field doesnt use macro
  • Loading branch information
mattjala authored Jun 19, 2024
1 parent e7796a6 commit 90cfab3
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion src/H5CX.c
Original file line number Diff line number Diff line change
Expand Up @@ -2351,7 +2351,7 @@ H5CX_get_filter_cb(H5Z_cb_t *filter_cb)
/*-------------------------------------------------------------------------
* Function: H5CX_get_data_transform
*
* Purpose: Retrieves the I/O filter callback function for the current API call context.
* Purpose: Retrieves the data transformation expression for the current API call context.
*
* Return: Non-negative on success / Negative on failure
*
Expand All @@ -2371,6 +2371,9 @@ H5CX_get_data_transform(H5Z_data_xform_t **data_transform)
assert(head && *head);
assert(H5P_DEFAULT != (*head)->ctx.dxpl_id);

/* This getter does not use H5CX_RETRIEVE_PROP_VALID in order to use H5P_peek instead of H5P_get.
This prevents invocation of the data transform property's library-defined copy callback */

/* Check if the value has been retrieved already */
if (!(*head)->ctx.data_transform_valid) {
/* Check for default DXPL */
Expand Down

0 comments on commit 90cfab3

Please sign in to comment.