io_wrapper_is_memory_based

March 26, 2020

Name

io_wrapper_is_memory_based — returns the memtype if an io_object is an in-memory io_object

Synopsis

#include "io_wrapper.h"

| int **io_wrapper_is_memory_based** ( | io, |   |
|   | buf, |   |
|   | len); |   |

io_object * <var class="pdparam">io</var>;
char ** <var class="pdparam">buf</var>;
size_t * <var class="pdparam">len</var>;

Description

Note

This reference page was automatically generated from functions found in the header files in the development branch. The function described here may not exist in generally available versions of Momentum, and may change in behavior when it is generally available. Consult your vendor for definitive advice on the use of this function.

returns the memtype if an io_object is an in-memory io_object.

Parameters

io

the io object

buf

pointer to a variable to hold the buffer pointer (may be NULL)

len

pointer to a variable to hold the buffer length (may be NULL)

Return Values

Returns 0 if the object doesn’t represent a memory based object, otherwise returns the memory type for the memory. If buf is non-NULL, it will be updated to hold the pointer to the start of the memory blob. If len is non-NULL, it will be updated to hold the size of the memory blob.