IDCompositionVisual::RemoveVisual method (dcomp.h)

Article
02/22/2024

Removes a child visual from the children list of this visual.

Syntax

HRESULT RemoveVisual(
  [in] IDCompositionVisual *visual
);

Parameters

[in] visual

Type: IDCompositionVisual*

The child visual to remove from the children list. This parameter must not be NULL.

Return value

Type: HRESULT

If the function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. See DirectComposition Error Codes for a list of error codes.

Remarks

The child visual is removed from the list of children. The order of the remaining child visuals is not changed.

This method fails if visual is not a child of the parent visual.

Requirements

Requirement	Value
Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Target Platform	Windows
Header	dcomp.h
Library	Dcomp.lib
DLL	Dcomp.dll