InitVariantFromResource function

Initializes a VARIANT structure based on a string resource imbedded in an executable file.

Syntax


HRESULT InitVariantFromResource(
  _In_  HINSTANCE hinst,
  _In_  UINT      id,
  _Out_ VARIANT   *pvar
);

Parameters

hinst [in]

Type: HINSTANCE

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

id [in]

Type: UINT

Integer identifier of the string to be loaded.

pvar [out]

Type: VARIANT*

When this function returns, contains the initialized VARIANT structure.

Return value

Type: HRESULT

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

Remarks

Creates a VT_BSTR variant. If the resource does not exist, this function initializes the VARIANT as VT_EMPTY and returns a failure code.

Examples

The following example, to be included as part of a larger program, demonstrates how to use InitVariantFromResource.


// HINSTANCE hinst;
// UINT id;
// Assume variables hinst and id are initialized and valid.
VARIANT var;

HRESULT hr = InitVariantFromResource(hinst, id, &var);

if (SUCCEEDED(hr))
{
    // var now is valid and has type VT_BSTR.
    VariantClear(&var);
}

Requirements

Minimum supported client

Windows XP with SP2, Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 with SP1 [desktop apps only]

Redistributable

Windows Desktop Search (WDS) 3.0

Header

Propvarutil.h

Library

Propsys.lib

DLL

Propsys.dll (version 6.0 or later)

See also

VariantToString
VariantToStringWithDefault
InitVariantFromString
InitPropVariantFromResource
LoadString

 

 

Show: