contents   index   previous   next





SEContext.seInternalizeString(String string)






string the text of the member name to internalize



The internalized string handle



All object member names are internalized by the ScriptEase engine before use. This API call is used to get the internalized version of a particular string. It is useful for commonly-used strings as whenever you use the text of the string, ScriptEase must internalize that string. In addition, ScriptEase internal strings can be directly compared using a single == comparison rather than the much slower String.equals.


The resulting handle can be used as a member name using the SE.STR() member description specifier. In addition, object callbacks return internal handles for the member name being accessed.


ScriptEase internal strings are always locked until explicitly freed. Use seFreeInternalString to indicate you are finished with a particular internal handle. You can also duplicate an string handle using seCloneInternalString. Refer to the standard ScriptEase lifetime model, as internal strings follow that with the exception that no internal strings are freed automatically when a wrapper function exits.


The difference between seInternalizeString() and seInternalizeStringHidden() is that seInternalizeStringHidden() will create a property name that is not accesible from scripts (similar to SE.HIDDEN_MEM or SE.HIDDEN_UNIMEM).



seCloneInternalString, seFreeInternalString, seGetInternalString