LString Class Reference

Detailed Description

The UTF8 character string. The array is resolved as the following in different languages APIs.

Input Parameter

C++

// single string
void Function(... const std::wstring& x, ...);
// an array of string
void Function(... const std::vector<wstring>& x, ...);

C#

// single string
void Function(... string x, ...);
// an array of string
void Function(... System.Array x, ...);

COM

// single string
void Function(... BSTR x, ...);
// an array of string
void Function(... SAFEARRAY* x, ...);

Output Parameter

C++

// single string
void Function(... std::wstring& x, ...);
// an array of string
void Function(... std::vector<wstring>& x, ...);

C#

// single string
void Function(... out string x, ...);
// an array of string
void Function(... out System.Array x, ...);

COM

// single string
void Function(... BSTR* x, ...);
// an array of string
void Function(... SAFEARRAY** x, ...);

Return Value

C++

// single string
std::wstring Function(...);
// an array of string
std::vector<std::wstring> Function(...);

C#

// single string
string Function(...);
// an array of string
System.Array Function(...);

COM

// single string
BSTR Function(...);
// an array of string
SAFEARRAY* Function(...);

Example Code

C++

// input string
img1->Load(L"path_to_img_file1");
std::wstring path = L"path_to_img_file2";
img2->Load(path);
 
// string property
std::wstring ocrString = ocrResult->String;
 
// get an array of string as result
std::vector<std::wstring> strlist = ibData->ToStringList();

C#

// input string
img1.Load("path_to_img_file1");
string path = "path_to_img_file2";
img2.Load(path);
 
// string property
string ocrString = ocrResult.String;
 
// get an array of string as result
Array strlist = ibData.ToStringList();
string[] strs = strlist.OfType<string>().ToArray();

COM

// input string
img1->Load(L"path_to_img_file1");
CString path = L"path_to_img_file2";
img2->Load(path.GetString());
 
// string property
CString ocrString = ocrResult->String;
 
// get an array of string as result
SAFEARRAY* strArr = ibData->ToStringList();
CComSafeArray<BSTR> strlist;
if (strlist) strlist.Attach(strArr);