LEADTOOLS Common Dialog C++ Class Library Help
| LEADTOOLS Common Dialog C++ Class Library Help > Classes and Functions Members > LDialogBase > LDialogBase Class Members > LDialogBase::GetString |
#include "ltwrappr.h"
static L_INT LDialogBase::GetString(uString, szString, sizeInWords)
|
L_UINT32 uString; |
/* index of a string */ |
|
L_TCHAR * szString; |
/* pointer to the variable to be updated */ |
|
L_SIZE_T sizeInWords; |
/* size of the szString string buffer */ |
Gets the current string for the specified index.
|
Parameter |
Description |
|
uString |
Index into a list of strings. For a list of the strings, refer to Dialog Strings. |
|
pszString |
Pointer to the buffer to be updated with the current string. |
|
sizeInWords |
Size of the szString string buffer in words. |
Returns
|
SUCCESS |
The function was successful. |
|
< 1 |
An error occurred. Refer to Return Codes. |
Comments
Before calling this function, call LDialogBase::GetStringLen to get the length of the text you want to retrieve.
Before calling this function, you must declare a variable as a pointer to a character string. You must allocate enough memory to hold the character string. Then, pass the variable in the szString parameter. This function will update the variable with the character string at the given index.
Required DLLs and Libraries
|
LTDLGKRN For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application |
See Also
|
Functions: |
LDialogBase::GetStringLen, LDialogBase::SetString, LDialogBase::SetFont, Class Members |
|
Topics: |
Example
For an example, refer to LDialogBase::SetFont.
