LEADTOOLS Common Dialog C DLL Help > Function References > L_DlgGetString |
#include "l_bitmap.h"
L_LTDLG_API L_INT L_DlgGetString(uString, pszString, sizeInWords)
L_UINT32 uString; |
/* index of a string */ |
L_TCHAR * pszString; |
/* pointer to the variable to be updated */ |
L_SIZE_T sizeInWords; |
/* size of the pszString 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 pszString string buffer in words. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
Before calling this function, call L_DlgGetStringLen 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 pszString 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: |
|
Topics: |
|
|
Example
For an example, refer to L_DlgSetFont.