UID | title | description | helpviewer_keywords | old-location | tech.root | ms.assetid | ms.date | ms.keywords | req.header | req.include-header | req.target-type | req.target-min-winverclnt | req.target-min-winversvr | req.kmdf-ver | req.umdf-ver | req.ddi-compliance | req.unicode-ansi | req.idl | req.max-support | req.namespace | req.assembly | req.type-library | req.lib | req.dll | req.irql | targetos | req.typenames | req.redist | ms.custom | f1_keywords | dev_langs | topic_type | api_type | api_location | api_name | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
NF:propvarutil.InitPropVariantFromResource |
InitPropVariantFromResource function (propvarutil.h) |
Initializes a PROPVARIANT structure based on a string resource embedded in an executable file. |
|
properties\InitPropVariantFromResource.htm |
properties |
c958f823-f820-4b0b-86ed-84ad18befbd1 |
12/05/2018 |
InitPropVariantFromResource, InitPropVariantFromResource function [Windows Properties], properties.InitPropVariantFromResource, propvarutil/InitPropVariantFromResource, shell.InitPropVariantFromResource, shell_InitPropVariantFromResource |
propvarutil.h |
Windows |
Windows XP with SP2, Windows Vista [desktop apps only] |
Windows Server 2003 with SP1 [desktop apps only] |
Propsys.lib |
Propsys.dll (version 6.0 or later) |
Windows |
Windows Desktop Search (WDS) 3.0 |
19H1 |
|
|
|
|
|
|
Initializes a PROPVARIANT structure based on a string resource embedded in an executable file.
Type: HINSTANCE
Handle to an instance of the module whose executable file contains the string resource.
Type: UINT
Integer identifier of the string to be loaded.
Type: PROPVARIANT*
When this function returns, contains the initialized PROPVARIANT structure.
Type: HRESULT
If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
This function creates a VT_LPWSTR propvariant. If the specified resource does not exist, it initializes the PROPVARIANT with an empty string. Resource strings longer than 1024 characters are truncated and null-terminated.
The following example, to be included as part of a larger program, demonstrates how to use InitPropVariantFromResource.
// HINSTANCE hinst;
// UINT id;
// Assume variables hinst and id are initialized and valid.
PROPVARIANT propvar;
HRESULT hr = InitPropVariantFromResource(hinst, id, &propvar);
if (SUCCEEDED(hr))
{
// propvar now is valid and has type VT_LPWSTR.
PropVariantClear(&propvar);
}