SK_StringDispose Function

Disposes a string, which clears it from memory and sets it's pointer to NULL (0).

Syntax

C/C++
SK_ResultCode SK_StringDispose(int flags, char **ptr);
Visual Basic
Declare Function SK_StringDispose(ByVal flags As Long, ByRef ptr As String) As Long

Arguments

flags
Any flags passed into this function-call.
ptr
Reference/pointer to a string pointer.

Returns

All possible return values are included in the SK_ResultCode enumeration. Return codes to expect include:

Result Code Description
SK_ResultCode.SK_ERROR_NONE No error.
SK_ResultCode.SK_ERROR_INVALID_ARGUMENTS Some or all of the arguments are invalid.