Platform SDK: International Features

ScriptStringFree

The ScriptStringFree function frees a SCRIPT_STRING_ANALYSIS structure.

HRESULT WINAPI ScriptStringFree(
  SCRIPT_STRING_ANALYSIS *pssa  
);

Parameters

pssa
[in/out] Pointer to a SCRIPT_STRING_ANALYSIS structure.

Return Values

If the function is successful, it returns S_OK.

If the function fails, it returns another HRESULT value. And if any other unrecoverable error is encountered, it is also returned as HRESULT. For example, error returns from Win32 API functions are converted to HRESULT using the HRESULT_FROM_WIN32 macro and returned to the client in the HRESULT.

The return value can be tested with the SUCCEEDED and FAILED macros.

Remarks

When you are finished with a SCRIPT_STRING_ANALYSIS structure, you should free its associated memory.

Note, after this function is called, the pointers returned from ScriptString_pcOutChars, ScriptString_pLogAttr, and ScriptString_pSize that are associated with the pssa are invalid.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Header: Declared in Usp10.h.
  Library: Use Usp10.lib.

See Also

Uniscribe Overview, Uniscribe Functions, ScriptString_pcOutChars, ScriptString_pLogAttr, ScriptString_pSize, SCRIPT_STRING_ANALYSIS