LDialogBase::GetString

Summary

Gets the current string for the specified index.

Syntax

#include "ltwrappr.h"

static L_INT LDialogBase::GetString(uString, szString, sizeInWords)

Parameters

L_UINT32 uString

Index into a list of strings. For a list of the strings, refer to Dialog Strings.

L_TCHAR * szString

Pointer to the buffer to be updated with the current string.

L_SIZE_T sizeInWords

Size of the szString string buffer in words.

Returns

Value Meaning
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

See Also

Functions

Topics

Example

For an example, refer to LDialogBase::SetFont.

Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Common Dialog C++ Class Library Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.