acNodeMapGetStringValue

lucid_arena_sys

Function acNodeMapGetStringValue 

Source 
pub unsafe extern "C" fn acNodeMapGetStringValue(
    hNodeMap: acNodeMap,
    pNodeName: *const c_char,
    pValueBuf: *mut c_char,
    pBufLen: *mut usize,
) -> AC_ERROR
Expand description

@fn AC_ERROR AC_API acNodeMapGetStringValue(acNodeMap hNodeMap, const char* pNodeName, char* pValueBuf, size_t* pBufLen)

@param hNodeMap

  • Type: acNodeMap
  • [In] parameter
  • A node map

@param pNodeName

  • Type: const char*
  • [In] parameter
  • Name of the node

@param pValueBuf

  • Type: char*
  • [Out] parameter
  • Accepts null
  • Value of the node

@param pBufLen

  • Type: size_t*
  • [In/out] parameter
  • (In) Length of the buffer
  • (Out) Length of the value

@return

  • Type: AC_ERROR
  • Error code for the function
  • Returns SC_ERR_SUCCESS (0) on success

acNodeMapGetStringValue acts as a shortcut for retrieving the value of a string node.