InitPropVariantFromString function
Applies to: desktop apps only
Initializes a PROPVARIANT structure based on a specified string.
Syntax
HRESULT InitPropVariantFromString( __in PCWSTR psz, __out PROPVARIANT *ppropvar );
Parameters
- psz [in]
-
Type: PCWSTR
Pointer to a buffer that contains the source Unicode string.
- ppropvar [out]
-
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 is an inline function, with its source code provided in the header. It is not included in any .dll or .lib file.
Examples
The following example, to be included as part of a larger program, demonstrates how to use InitPropVariantFromString.
PROPVARIANT propvar;
HRESULT hr = InitPropVariantFromString(L"Hello World", &propvar);
if (SUCCEEDED(hr))
{
// propvar now is valid and has type VT_LPWSTR.
PropVariantClear(&propvar);
}
Requirements
|
Minimum supported client | Windows XP with SP2, Windows Vista |
|---|---|
|
Minimum supported server | Windows Server 2003 with SP1 |
|
Redistributable | Windows Desktop Search (WDS) 3.0 |
|
Header |
|
See also
- PropVariantToString
- PropVariantToStringWithDefault
- InitPropVariantFromStringAsVector
- InitPropVariantFromStringVector
- InitVariantFromString
Send comments about this topic to Microsoft
Build date: 2/3/2012
