FSCRT_BSTR Struct Reference

Structure for byte string. More...

#include <fs_base_r.h>

Public Attributes

FS_LPSTR str
 String buffer. More...
 
FS_DWORD len
 Length of a string, in bytes. More...
 

Detailed Description

Structure for byte string.

Note
In PDF SDK, a byte string commonly means a UTF-8 format string, except for explicit explanation.
Foxit PDF SDK will call function FSCRT_Memory_Alloc, FSCRT_Memory_Realloc or FSCRT_Memory_Free to maintain string buffer internally.
Applications can manage private memory by themselves and need to make sure there is enough memory in this case.

Member Data Documentation

FS_DWORD FSCRT_BSTR::len

Length of a string, in bytes.

Note
In PDF SDK, if a function returns a string by a FSCRT_BSTR structure, string buffer will be extended if the given length is not enough.
FS_LPSTR FSCRT_BSTR::str

String buffer.

Note
It is not allowed to use stack space for string buffer. It is recommended to use heap space to allocate memory for string buffer. PDF SDK provides functions FSCRT_BStr_XXX to help applications maintain string buffer.

The documentation for this struct was generated from the following file:

Foxit Corporation