Share this page

# GetBufferFrom<n>DByteArray

Creating Instances

Gets a buffer at the specified n-1 indices from the last dimension of an n-dimensional byte array.

    char *GetBufferFrom<n>DByteArray( ByteArray Array, int ind1...indn-1, size_t *pLineSize );

Array | A byte array
int1...indn-1 | A comma-delimited list of the indices of the first n-1 dimensions where the buffer is located
*pLineSize | A pointer that returns the size of the buffer

The GetBufferFrom<n>DByteArray family of functions fetch a buffer from the last dimension of an n-dimensional byte array. The return value of the functions is a pointer to a byte buffer. The size of the buffer is returned at the address indicated by *plinesize.

These calls are generated by VuGen for your use in parameterization. You can uncomment the functions and use them as inputs to other calls.

The common function calls of this type are:

    GetBufferFrom1DByteArray

    GetBufferFrom2DByteArray

    GetBufferFrom3DByteArray

    GetBufferFrom4DByteArray

    GetBufferFrom5DByteArray

    GetBufferFrom6DByteArray

    GetBufferFrom7DByteArray

    GetBufferFrom8DByteArray

    GetBufferFrom9DByteArray

## Return Values

lrc Return Values

## Parameterization

Parameterization is not applicable to this function.

## Example

This example fills a byte array with strings of characters and then fetches them.

Copy code

            ByteArray Var;        Var = Create3DByteArray(0, 2, 0, 3, 0, 4);
            Fill3DByteArray(Var, 0, 0, "abcd", 4);
            Fill3DByteArray(Var, 0, 1, "efgh", 4);
            Fill3DByteArray(Var, 0, 2, "ijkl", 4);
            Fill3DByteArray(Var, 1, 0, "mnop", 4);
            Fill3DByteArray(Var, 1, 1, "qrst", 4);
            Fill3DByteArray(Var, 1, 2, "uvwx", 4);
            GetBufferFrom3DByteArray(Var, 0, 0, NULL);    //expected: "abcd"
            GetBufferFrom3DByteArray(Var, 0, 1, NULL);    //expected: "efgh"
            GetBufferFrom3DByteArray(Var, 0, 2, NULL);    //expected: "ijkl"
            GetBufferFrom3DByteArray(Var, 1, 0, NULL);    //expected: "mnop"
            GetBufferFrom3DByteArray(Var, 1, 1, NULL);    //expected: "qrst"
            GetBufferFrom3DByteArray(Var, 1, 2, NULL);    //expected: "uvwx"

Tips to improve your search results... VuGen Function Reference Version 26.1-26.3 Function Reference 26.1-26.3 All View Local Help Center View Online Help Center Version: