gobj_set_volatil()

Sets or clears the gobj_flag_volatil flag for the given hgobj instance.

C

Prototype

int gobj_set_volatil(
    hgobj gobj, 
    BOOL set
);

Parameters

Key	Type	Description
gobj	hgobj	The hgobj instance whose volatility flag is to be modified.
set	BOOL	If TRUE, the gobj_flag_volatil flag is set; if FALSE, the flag is cleared.

---

Return Value

Returns 0 on success.

Notes

A volatile hgobj is typically used for temporary objects that should not persist beyond a certain scope.

JS

Prototype

// Not applicable in JS

Python

Prototype

# Not applicable in Python

Examples

C

// TODO C examples

JS

// TODO JS examples

Python

# TODO Python examples