InitPropVariantFromResource function (propvarutil.h)

Article
02/22/2024

Initializes a PROPVARIANT structure based on a string resource embedded in an executable file.

Syntax

PSSTDAPI InitPropVariantFromResource(
  [in]  HINSTANCE   hinst,
  [in]  UINT        id,
  [out] PROPVARIANT *ppropvar
);

Parameters

[in] hinst

Type: HINSTANCE

Handle to an instance of the module whose executable file contains the string resource.

[in] id

Type: UINT

Integer identifier of the string to be loaded.

[out] ppropvar

Type: PROPVARIANT*

When this function returns, contains the initialized PROPVARIANT structure.

Return value

Type: HRESULT

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

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.

Examples

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);
}

Requirements

Requirement	Value
Minimum supported client	Windows XP with SP2, Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 with SP1 [desktop apps only]
Target Platform	Windows
Header	propvarutil.h
Library	Propsys.lib
DLL	Propsys.dll (version 6.0 or later)
Redistributable	Windows Desktop Search (WDS) 3.0