PropVariantToInt16Vector function (propvarutil.h)
Extracts a vector of Int16 values from a PROPVARIANT structure.
Syntax
PSSTDAPI PropVariantToInt16Vector(
[in] REFPROPVARIANT propvar,
[out] SHORT *prgn,
[in] ULONG crgn,
[out] ULONG *pcElem
);
Parameters
[in] propvar
Type: REFPROPVARIANT
Reference to a source PROPVARIANT structure.
[out] prgn
Type: SHORT*
Points to a buffer containing crgn SHORT values. When this function returns, the buffer has been initialized with pcElem SHORT elements extracted from the source PROPVARIANT structure.
[in] crgn
Type: ULONG
Size of the buffer pointed to by prgn in elements.
[out] pcElem
Type: ULONG*
When this function returns, contains the count of Int16 elements extracted from source PROPVARIANT structure.
Return value
Type: HRESULT
This function can return one of these values.
Return code | Description |
---|---|
|
Returns S_OK if successful, or an error value otherwise. |
|
The source PROPVARIANT contained more than crgn values. The buffer pointed to by prgn. |
|
ThePROPVARIANT was not of the appropriate type. |
Remarks
This helper function is used in places where the calling application expects a PROPVARIANT to hold an Int16 vector value with a fixed number of elements.
If the source PROPVARIANT has type VT_VECTOR | VT_I2 or VT_ARRAY | VT_I2, this helper function extracts up to crgn Int16 values and places them into the buffer pointed to by prgn. If the PROPVARIANT contains more elements than will fit into the prgn buffer, this function returns an error and sets pcElem to 0.
Examples
// PROPVARIANT propvar;
// Assume the variable propvar is initialized and valid
SHORT rgShorts[4]; // The application is expecting propvar to hold 4 Int16s in a vector
ULONG cElems;
HRESULT hr = PropVariantToInt16Vector(propvar, rgShorts, ARRAYSIZE(rgShorts), &cElems);
if (SUCCEEDED(hr))
{
if (cElems == ARRAYSIZE(rgShorts))
{
// The application got 4 Int16s which are now stored in rgShorts
}
else
{
// The application got cElems which are stored in the first cElems elements of rgShorts
}
}
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 |