idWriteTextLayout：：GetClusterMetrics 方法 (dwrite.h)

检索每个字形群集的逻辑属性和度量值。

语法

HRESULT GetClusterMetrics(
  [out, optional] DWRITE_CLUSTER_METRICS *clusterMetrics,
                  UINT32                 maxClusterCount,
  [out]           UINT32                 *actualClusterCount
);

参数

[out, optional] clusterMetrics

类型： DWRITE_CLUSTER_METRICS*

此方法返回时，包含字形群集的指标，例如换行符或总前行宽度。

maxClusterCount

类型： UINT32

clusterMetrics 数组的最大大小。

[out] actualClusterCount

类型： UINT32*

此方法返回时，包含所需的 clusterMetrics 数组的实际大小。

返回值

类型： HRESULT

如果该方法成功，则返回 S_OK。 否则，将返回 HRESULT 错误代码。

备注

如果 maxClusterCount 不够大，则返回等效于 HRESULT_FROM_WIN32 (ERROR_INSUFFICIENT_BUFFER) E_NOT_SUFFICIENT_BUFFER，并将 actualClusterCount 设置为所需的群集数。

要求

最低受支持的客户端	Windows 7、带 SP2 的 Windows Vista 和适用于 Windows Vista 的平台更新 [桌面应用 |UWP 应用]
最低受支持的服务器	Windows Server 2008 R2、Windows Server 2008 SP2 和适用于 Windows Server 2008 的平台更新 [桌面应用 |UWP 应用]
目标平台	Windows
标头	dwrite.h
Library	Dwrite.lib
DLL	Dwrite.dll

另请参阅

IDWriteTextLayout