Prev Next

LoadString info  Overview  Group

The LoadString function loads a string resource from the executable file associated with a specified module, copies the string into a buffer, and appends a terminating null character.

int LoadString(

    HINSTANCE hInstance,

// handle of module containing string resource

    UINT uID,

// resource identifier

    LPTSTR lpBuffer,

// address of buffer for resource

    int nBufferMax 

// size of buffer

   );

Parameters

hInstance
Identifies an instance of the module whose executable file contains the string resource.
uID
Specifies the integer identifier of the string to be loaded.
lpBuffer
Points to the buffer to receive the string.
nBufferMax
Specifies the size of the buffer in bytes (ANSI version) or characters (Unicode version). The string is truncated and null terminated if it is longer than the number of characters specified.

Return Values

If the function succeeds, the return value is the number of bytes (ANSI version) or characters (Unicode version) copied into the buffer, not including the null-terminating character, or zero if the string resource does not exist. To get extended error information, call GetLastError.

See Also

FormatMessage, LoadAccelerators, LoadBitmap, LoadCursor, LoadIcon, LoadMenu, LoadMenuIndirect