# C1.Util.DX.DirectWrite.TextLayout.GetClusterMetrics

## Content

<div class="doc-site-dotnet-api-container">



<h1 id="C1_Util_DX_DirectWrite_TextLayout_GetClusterMetrics_" data-uid="C1.Util.DX.DirectWrite.TextLayout.GetClusterMetrics*">GetClusterMetrics Method
</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>



<a id="C1_Util_DX_DirectWrite_TextLayout_GetClusterMetrics_" data-uid="C1.Util.DX.DirectWrite.TextLayout.GetClusterMetrics*"></a>
<h4 id="C1_Util_DX_DirectWrite_TextLayout_GetClusterMetrics" data-uid="C1.Util.DX.DirectWrite.TextLayout.GetClusterMetrics">GetClusterMetrics()</h4>
<div class="markdown level1 summary"><p>Retrieves logical properties and measurements of each glyph cluster.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
  <pre><code class="lang-csharp hljs">public ClusterMetrics[] GetClusterMetrics()</code></pre>
</div>
<div class="codewrapper">
  <pre><code class="lang-vbnet hljs">Public Function GetClusterMetrics() As ClusterMetrics()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-condensed">
  <thead>
    <tr>
      <th>Type</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><a class="xref" href="C1.Util.DX.DirectWrite.ClusterMetrics.html">ClusterMetrics</a>[]</td>
      <td><p>Returns metrics, such as line-break or total advance width, for a glyph cluster.</p>
</td>
    </tr>
  </tbody>
</table>
<h5 id="C1_Util_DX_DirectWrite_TextLayout_GetClusterMetrics_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>If maxClusterCount is not large enough, then E_NOT_SUFFICIENT_BUFFER, which is equivalent to HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER), is returned and actualClusterCount is set to the number of clusters needed.</p>
</div>


<a id="C1_Util_DX_DirectWrite_TextLayout_GetClusterMetrics_" data-uid="C1.Util.DX.DirectWrite.TextLayout.GetClusterMetrics*"></a>
<h4 id="C1_Util_DX_DirectWrite_TextLayout_GetClusterMetrics_C1_Util_DX_DirectWrite_ClusterMetrics___System_Int32_System_Int32__" data-uid="C1.Util.DX.DirectWrite.TextLayout.GetClusterMetrics(C1.Util.DX.DirectWrite.ClusterMetrics[],System.Int32,System.Int32@)">GetClusterMetrics(ClusterMetrics[], int, out int)</h4>
<div class="markdown level1 summary"><p>HRESULT IDWriteTextLayout::GetClusterMetrics([Out, Buffer, Optional] DWRITE_CLUSTER_METRICS* clusterMetrics,[In] unsigned int maxClusterCount,[Out] unsigned int* actualClusterCount)</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
  <pre><code class="lang-csharp hljs">public HResult GetClusterMetrics(ClusterMetrics[] clusterMetrics, int maxClusterCount, out int actualClusterCount)</code></pre>
</div>
<div class="codewrapper">
  <pre><code class="lang-vbnet hljs">Public Function GetClusterMetrics(clusterMetrics As ClusterMetrics(), maxClusterCount As Integer, ByRef actualClusterCount As Integer) As HResult</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-condensed">
  <thead>
    <tr>
      <th>Type</th>
      <th>Name</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><a class="xref" href="C1.Util.DX.DirectWrite.ClusterMetrics.html">ClusterMetrics</a>[]</td>
      <td><span class="parametername">clusterMetrics</span></td>
      <td></td>
    </tr>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></td>
      <td><span class="parametername">maxClusterCount</span></td>
      <td></td>
    </tr>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></td>
      <td><span class="parametername">actualClusterCount</span></td>
      <td></td>
    </tr>
  </tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-condensed">
  <thead>
    <tr>
      <th>Type</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><a class="xref" href="C1.Util.DX.HResult.html">HResult</a></td>
      <td></td>
    </tr>
  </tbody>
</table>
</div>