/**
* This method is called when we receive a WPD_COMMAND_OBJECT_PROPERTIES_BULK_GET_VALUES_BY_OBJECT_LIST_START
* command.
*
* The parameters sent to us are:
* - WPD_PROPERTY_OBJECT_PROPERTIES_BULK_OBJECT_IDS: identifies the objects whose property
* values we want to return.
* - WPD_PROPERTY_OBJECT_PROPERTIES_BULK_PROPERTY_KEYS: a collection of property keys, identifying which
* specific property values we are requested to return. If this property doesn't exist,
* then the client is asking for all values.
*
* The driver should:
* - Create a new context for this bulk property operation.
* - Return an identifier for the context in WPD_PROPERTY_OBJECT_PROPERTIES_BULK_CONTEXT.
*/
HRESULT WpdObjectPropertiesBulk::OnGetValuesByObjectListStart(
__in IPortableDeviceValues* pParams,
__out IPortableDeviceValues* pResults)
{
HRESULT hr = S_OK;
CComPtr<IPortableDevicePropVariantCollection> pObjectIDs;
CComPtr<IPortableDeviceKeyCollection> pKeys;
ContextMap* pContextMap = NULL;
// Get the IPortableDevicePropVariantCollection which contains the collection
// of object identifiers the bulk operation is being performed on.
if (hr == S_OK)
{
hr = pParams->GetIPortableDevicePropVariantCollectionValue(WPD_PROPERTY_OBJECT_PROPERTIES_BULK_OBJECT_IDS, &pObjectIDs);
CHECK_HR(hr, "Missing value for WPD_PROPERTY_OBJECT_PROPERTIES_BULK_OBJECT_IDS");
}
// Get the IPortableDeviceKeyCollection which contains the collection
// keys of properties being read on the multiple objects.
if (hr == S_OK)
{
hr = pParams->GetIPortableDeviceKeyCollectionValue(WPD_PROPERTY_OBJECT_PROPERTIES_BULK_PROPERTY_KEYS, &pKeys);
if(hr != S_OK)
{
// Client is asking for all properties.
pKeys = NULL;
hr = S_OK;
}
}
// Get the context map which the driver stored in pParams for convenience
if (hr == S_OK)
{
hr = pParams->GetIUnknownValue(PRIVATE_SAMPLE_DRIVER_CLIENT_CONTEXT_MAP, (IUnknown**)&pContextMap);
CHECK_HR(hr, "Failed to get PRIVATE_SAMPLE_DRIVER_CLIENT_CONTEXT_MAP");
}
if (hr == S_OK)
{
LPWSTR pwszContext = NULL;
ACCESS_SCOPE Scope = m_pDevice->GetAccessScope(pParams);
hr = CreateBulkPropertiesContext(Scope, pContextMap, pObjectIDs, pKeys, &pwszContext);
if (hr == S_OK)
{
hr = pResults->SetStringValue(WPD_PROPERTY_OBJECT_PROPERTIES_BULK_CONTEXT, pwszContext);
CHECK_HR(hr, "Failed to set WPD_PROPERTY_OBJECT_PROPERTIES_BULK_CONTEXT");
}
// Free the memory. CoTaskMemFree ignores NULLs so no need to check.
CoTaskMemFree(pwszContext);
}
SAFE_RELEASE(pContextMap);
return hr;
}
HRESULT WpdObjectPropertiesBulk::CreateBulkPropertiesContext(
_In_ ACCESS_SCOPE Scope,
_In_ ContextMap* pContextMap,
_In_ REFGUID guidObjectFormat,
_In_ LPCWSTR pszParentObjectID,
_In_ DWORD dwDepth,
_In_ IPortableDeviceKeyCollection* pProperties,
_Outptr_result_nullonfailure_ LPWSTR* ppszBulkPropertiesContext)
{
HRESULT hr = S_OK;
CComPtr<IPortableDevicePropVariantCollection> pObjectIDs;
if((pContextMap == NULL) ||
(pszParentObjectID == NULL) ||
(ppszBulkPropertiesContext == NULL))
{
hr = E_POINTER;
CHECK_HR(hr, "Cannot have NULL parameter");
return hr;
}
*ppszBulkPropertiesContext = NULL;
hr = CoCreateInstance(CLSID_PortableDevicePropVariantCollection,
NULL,
CLSCTX_INPROC_SERVER,
IID_IPortableDevicePropVariantCollection,
(VOID**) &pObjectIDs);
CHECK_HR(hr, "Failed to CoCreate CLSID_IPortableDevicePropVariantCollection");
if (SUCCEEDED(hr))
{
hr = m_pDevice->GetObjectIDsByFormat(Scope, guidObjectFormat, pszParentObjectID, dwDepth, pObjectIDs);
CHECK_HR(hr, "Faield to get list of object ids by format");
}
if (SUCCEEDED(hr))
{
hr = CreateBulkPropertiesContext(Scope, pContextMap, pObjectIDs, pProperties, ppszBulkPropertiesContext);
}
return hr;
}
/**
* This method is called when we receive a WPD_COMMAND_OBJECT_PROPERTIES_BULK_SET_VALUES_BY_OBJECT_LIST_START
* command.
*
* The parameters sent to us are:
* - WPD_PROPERTY_OBJECT_PROPERTIES_BULK_VALUES: holds a collection of IPortableDeviceValues which
* indicate which object properties to set.
*
* The driver should:
* - Create a new context for this bulk property operation.
* - Return an identifier for the context in WPD_PROPERTY_OBJECT_PROPERTIES_BULK_CONTEXT.
*/
HRESULT WpdObjectPropertiesBulk::OnSetValuesByObjectListStart(
_In_ IPortableDeviceValues* pParams,
_In_ IPortableDeviceValues* pResults)
{
HRESULT hr = S_OK;
CComPtr<IPortableDeviceValuesCollection> pValuesCollection;
ContextMap* pContextMap = NULL;
// Get the IPortableDevicePropVariantCollection which contains the collection
// of object identifiers the bulk operation is being performed on.
hr = pParams->GetIPortableDeviceValuesCollectionValue(WPD_PROPERTY_OBJECT_PROPERTIES_BULK_VALUES, &pValuesCollection);
CHECK_HR(hr, "Missing value for WPD_PROPERTY_OBJECT_PROPERTIES_BULK_VALUES");
// Get the context map which the driver stored in pParams for convenience
if (SUCCEEDED(hr))
{
hr = pParams->GetIUnknownValue(PRIVATE_SAMPLE_DRIVER_CLIENT_CONTEXT_MAP, (IUnknown**)&pContextMap);
CHECK_HR(hr, "Failed to get PRIVATE_SAMPLE_DRIVER_CLIENT_CONTEXT_MAP");
}
if (SUCCEEDED(hr))
{
LPWSTR pwszContext = NULL;
ACCESS_SCOPE Scope = m_pDevice->GetAccessScope(pParams);
hr = CreateBulkPropertiesContext(Scope, pContextMap, pValuesCollection, &pwszContext);
if (SUCCEEDED(hr))
{
hr = pResults->SetStringValue(WPD_PROPERTY_OBJECT_PROPERTIES_BULK_CONTEXT, pwszContext);
CHECK_HR(hr, "Failed to set WPD_PROPERTY_OBJECT_PROPERTIES_BULK_CONTEXT");
}
// Free the memory. CoTaskMemFree ignores NULLs so no need to check.
CoTaskMemFree(pwszContext);
}
SAFE_RELEASE(pContextMap);
return hr;
}
/**
* This method is called when we receive a WPD_COMMAND_OBJECT_PROPERTIES_BULK_GET_VALUES_BY_OBJECT_FORMAT_START
* command.
*
* The parameters sent to us are:
* - WPD_PROPERTY_OBJECT_PROPERTIES_BULK_OBJECT_FORMAT: Identifies the format of the objects the
* client is interested in.
* - WPD_PROPERTY_OBJECT_PROPERTIES_BULK_PARENT_OBJECT_ID: Identifies the parent object from which the
* operation should start.
* - WPD_PROPERTY_OBJECT_PROPERTIES_BULK_DEPTH: Indicates the hierarchical depth of the operation
* from the parent object.
* - WPD_PROPERTY_OBJECT_PROPERTIES_BULK_PROPERTY_KEYS: a collection of property keys, identifying which
* specific property values we are requested to return. If this doesn't exist, then
* ALL object proeprties should be returned for the specified objects.
*
* The driver should:
* - Create a new context for this bulk property operation.
* - Return an identifier for the context in WPD_PROPERTY_OBJECT_PROPERTIES_BULK_CONTEXT.
*/
HRESULT WpdObjectPropertiesBulk::OnGetValuesByObjectFormatStart(
_In_ IPortableDeviceValues* pParams,
_In_ IPortableDeviceValues* pResults)
{
HRESULT hr = S_OK;
CComPtr<IPortableDeviceKeyCollection> pKeys;
GUID guidObjectFormat = GUID_NULL;
LPWSTR pszParentObjectID = NULL;
DWORD dwDepth = 0;
ContextMap* pContextMap = NULL;
// Get the object format.
hr = pParams->GetGuidValue(WPD_PROPERTY_OBJECT_PROPERTIES_BULK_OBJECT_FORMAT, &guidObjectFormat);
CHECK_HR(hr, "Missing value for WPD_PROPERTY_OBJECT_PROPERTIES_BULK_OBJECT_FORMAT");
// Get the parent object id.
if (SUCCEEDED(hr))
{
hr = pParams->GetStringValue(WPD_PROPERTY_OBJECT_PROPERTIES_BULK_PARENT_OBJECT_ID, &pszParentObjectID);
CHECK_HR(hr, "Missing value for WPD_PROPERTY_OBJECT_PROPERTIES_BULK_PARENT_OBJECT_ID");
}
// Get the depth.
if (SUCCEEDED(hr))
{
hr = pParams->GetUnsignedIntegerValue(WPD_PROPERTY_OBJECT_PROPERTIES_BULK_DEPTH, &dwDepth);
CHECK_HR(hr, "Missing value for WPD_PROPERTY_OBJECT_PROPERTIES_BULK_DEPTH");
}
// Get the IPortableDeviceKeyCollection which contains the collection
// keys of properties being read on the multiple objects.
if (SUCCEEDED(hr))
{
hr = pParams->GetIPortableDeviceKeyCollectionValue(WPD_PROPERTY_OBJECT_PROPERTIES_BULK_PROPERTY_KEYS, &pKeys);
if (FAILED(hr))
{
// Client is asking for all properties.
pKeys = NULL;
hr = S_OK;
}
}
// Get the context map which the driver stored in pParams for convenience
if (SUCCEEDED(hr))
{
hr = pParams->GetIUnknownValue(PRIVATE_SAMPLE_DRIVER_CLIENT_CONTEXT_MAP, (IUnknown**)&pContextMap);
CHECK_HR(hr, "Failed to get PRIVATE_SAMPLE_DRIVER_CLIENT_CONTEXT_MAP");
}
if (SUCCEEDED(hr))
{
LPWSTR pwszContext = NULL;
ACCESS_SCOPE Scope = m_pDevice->GetAccessScope(pParams);
hr = CreateBulkPropertiesContext(Scope, pContextMap, guidObjectFormat, pszParentObjectID, dwDepth, pKeys, &pwszContext);
if (SUCCEEDED(hr))
{
hr = pResults->SetStringValue(WPD_PROPERTY_OBJECT_PROPERTIES_BULK_CONTEXT, pwszContext);
CHECK_HR(hr, "Failed to set WPD_PROPERTY_OBJECT_PROPERTIES_BULK_CONTEXT");
}
// Free the memory. CoTaskMemFree ignores NULLs so no need to check.
CoTaskMemFree(pwszContext);
}
// Free the memory. CoTaskMemFree ignores NULLs so no need to check.
CoTaskMemFree(pszParentObjectID);
SAFE_RELEASE(pContextMap);
return hr;
}
