> home > Custom Layer Boundary API

get_buffer_by_name

January 19th 2020
Retrieve a buffer querying by name

Signature

C++
Buffer_ID
get_buffer_by_name(Application_Links* app,
                   String_Const_u8 name,
                   Access_Flag access);

Parameters

app

the standard custom layer context pointer

name

the name to query against buffer names

access

the type of access requirements used to determine whether or not to return a match

Return

the id of the buffer who's name agrees with name if it exists and it has the required access state, zero otherwise