ISideShowContent::DifferentiateContent Property

Article
11/02/2006

Returns a Boolean that determines whether the Windows Sideshow platform needs to make more than one call to the GetContent method.

Declaration

[C++]

HRESULT get_DifferentiateContent(
    BOOL *out_pfDifferentiateContent
);

Property Value

*out_pfDifferentiateContent

[out] A pointer to a Boolean flag into which the Windows SideShow gadget writes. True if the device intends to provide customized content based on the individual capabilities of the associated Windows SideShow-compatible devices; otherwise false.

This property is read-only.

Return Values

HRESULT value	Description
S_OK	Success, indicating that the Windows SideShow gadget successfully wrote the Boolean flag to the location provided by the Windows SideShow platform.
Other HRESULT values	The Windows SideShow gadget may return HRESULT values other than S_OK to communicate error conditions to the Windows SideShow platform.

Remarks

After a Windows SideShow gadget calls the Add method of the ISideShowContentManager interface, the Windows SideShow platform accesses this property first, using its value to determine whether it needs to make more than one call to the GetContent method.

If this method returns an HRESULT value other than S_OK, the corresponding call to the Add method of its ISideShowContentManager interface returns E_INVALIDARG.

Example

This example demonstrates one possible implementation of the ISideShowContent::DifferentiateContent Property in the client-implemented ISideShowContent interface. Other implementations are, of course, possible.

In this example, the Boolean value that determines whether content is differentiated was stored locally in the m_bDifferentiateContent member variable when the constructor for the CSideShowContent class was called.

[C++]

STDMETHODIMP CSideShowContent::get_DifferentiateContent(BOOL* pbDiffContentPerDevice)
{
    //
    // Copy the differentiate content Boolean value into the out
    // parameter and return successfully.
    //
    *pbDiffContentPerDevice = m_bDifferentiateContent;

    return S_OK;
}

Applies To

ISideShowContent