InitPropVariantFromStrRet 函数 (propvarutil.h)

基于 STRRET 结构中存储的字符串初始化 PROPVARIANT 结构。

语法

PSSTDAPI InitPropVariantFromStrRet(
  [in, out] STRRET          *pstrret,
  [in]      PCUITEMID_CHILD pidl,
  [out]     PROPVARIANT     *ppropvar
);

参数

[in, out] pstrret

类型: STRRET*

指向包含字符串的 STRRET 结构的指针。

[in] pidl

类型: PCUITEMID_CHILD

正在检索其详细信息的项的 PIDL。

[out] ppropvar

类型: PROPVARIANT*

当此函数返回时,包含初始化的 PROPVARIANT 结构。

返回值

类型: HRESULT

如果此函数成功,则返回 S_OK。 否则,将返回 HRESULT 错误代码。

注解

创建VT_LPWSTR支持变量。

注意 此函数释放用于 STRRET 内容的内存。
 

示例

以下示例将作为较大程序的一部分包含,演示如何使用 InitPropVariantFromStrRet

// STRRET strret;
// PCUITEMID_CHILD pidl;
// Assume variables strret and pidl are initialized and valid.
PROPVARIANT propvar;

HRESULT hr = InitPropVariantFromStrRet(strret, pidl, &propvar);

if (SUCCEEDED(hr))
{
    // propvar now is valid and has type VT_LPWSTR.
    PropVariantClear(&propvar);
    
    // Any allocated memory associated with strret has been freed.
}

要求

要求
最低受支持的客户端 Windows XP SP2、Windows Vista [仅限桌面应用]
最低受支持的服务器 Windows Server 2003 SP1 [仅限桌面应用]
目标平台 Windows
标头 propvarutil.h
Library Propsys.lib
DLL Propsys.dll (版本 6.0 或更高版本)
可再发行组件 Windows 桌面搜索 (WDS) 3.0

另请参阅

InitPropVariantFromString

InitVariantFromStrRet

PropVariantToString

PropVariantToStringWithDefault