WideStringFromResource function

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The WideStringFromResource function loads a wide-character string from a resource file with the given resource identifier.

Syntax

WCHAR* WINAPI WideStringFromResource(
   pBuffer *pBuffer,
   int     iResourceID
);

Parameters

pBuffer

Pointer to the string corresponding to iResourceID.

iResourceID

Resource identifier of the string to retrieve.

Return value

Returns the same string as pBuffer. If the function is not successful, returns a null string.

Remarks

Property pages are typically called through their COM interfaces, which use wide-character strings regardless of how the binary is built. This function allows you to convert a resource string to a wide-character string. The function converts the resource to a wide-character string (if it is not already one) after loading it.

Requirements

Requirement Value
Header
Wxutil.h (include Streams.h)
Library
Strmbase.lib (retail builds);
Strmbasd.lib (debug builds)

See also

Property Page Helper Functions