Function ovr_sys::ovr_GetString [−] [src]

pub unsafe extern "C" fn ovr_GetString(
    session: ovrSession, 
    propertyName: *const c_char, 
    defaultVal: *const c_char
) -> *const c_char

Reads a string property.

Strings are UTF8-encoded and null-terminated.

session Specifies an ovrSession previously returned by ovr_Create.

propertyName The name of the property, which needs to be valid only for the call.

defaultVal Specifes the value to return if the property couldn't be read.

Returns the string property if it exists. Otherwise returns defaultVal, which can be specified as NULL.

The return memory is guaranteed to be valid until next call to ovr_GetString or until the session is destroyed, whichever occurs first.