LoadStringByReference function (winnls.h)

Article
02/22/2024

Unsupported. LoadStringByReference may be altered or unavailable. Instead, use SHLoadIndirectString.

Syntax

BOOL LoadStringByReference(
  [in]            DWORD  Flags,
  [in, optional]  PCWSTR Language,
  [in]            PCWSTR SourceString,
  [out, optional] PWSTR  Buffer,
  [in]            ULONG  cchBuffer,
  [in, optional]  PCWSTR Directory,
  [out, optional] PULONG pcchBufferOut
);

Parameters

[in] Flags

Reserved.

[in, optional] Language

The language.

[in] SourceString

The source string reference.

[out, optional] Buffer

The buffer to receive the string.

[in] cchBuffer

The size of Buffer, in characters.

[in, optional] Directory

The directory path to SourceString.

[out, optional] pcchBufferOut

The number of characters written to Buffer.

Return value

A BOOL datatype.

Remarks

LoadStringByReference is not supported and may be altered or unavailable in the future. Instead, use SHLoadIndirectString.

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2008 R2 [desktop apps \| UWP apps]
Target Platform	Windows
Header	winnls.h (include Windows.h)
Library	Kernel32.lib
DLL	Kernel32.dll

Share via