LoadStringRC Function

  • Article

Translates an HRESULT value into an error message by using the default culture of the current thread.

This function has been deprecated in the .NET Framework 4.

Syntax

HRESULT LoadStringRC (  
    [in]  UINT    iResourceID,
    [out] LPWSTR  szBuffer,
    [in]  int     iMax,
    [in]  int     bQuiet  
);

Parameters

iResourceID
[in] An HRESULT.

szBuffer
[out] A buffer that contains the error message upon successful completion.

iMax
[in] The size of the error message buffer.

bQuiet
[in] Ignored.

Return Value

This method returns standard Component Object Model (COM) error codes, as defined in WinError.h, in addition to the following values.

Return code Description
S_OK The method completed successfully.
E_INVALIDARG szBuffer is null or iMax is zero (0).

Remarks

If the method does not complete successfully, szBuffer contains an empty string.

Requirements

Platforms: See System Requirements.

Header: MSCorEE.h

Library: MSCorEE.dll and Mscorwks.dll. Use MSCorEE.dll instead of Mscorwks.dll to ensure that you target the correct version of the .NET Framework.

.NET Framework Versions: Available since 2.0

See also