IAnalysisWarning::GetNodeIds method

Article
01/07/2021

Returns the identifiers of any relevant context nodes that are associated with this warning.

Syntax

HRESULT GetNodeIds(
  [in, out] ULONG *pulCount,
  [out]     GUID  **ppNodeIds
);

Parameters

pulCount [in, out]: The number of globally unique identifiers (GUIDs) in ppNodeIds.
ppNodeIds [out]: A pointer to an array of GUIDs that identifies the context nodes that are associated with this analysis warning, or NULL if no context nodes are associated with the warning.

Return value

For a description of the return values, see Classes and Interfaces - Ink Analysis.

Remarks

If ppNodeIds is passed as NULL, the GetNodeIds method returns S_OK and the number of rectangles is returned in pulCount.

Caution

To avoid a memory leak, use CoTaskMemFree to release the memory from *ppNodeIds when you no longer need the information.

Examples

The following example shows how to get the IContextNode objects that are in the IAnalysisWarning, warning, and how to get only the number of IContextNode objects

// Get the count of the context nodes and their identifiers.
ULONG count = 0;
GUID* nodeIds = 0;
warning->GetNodeIds(&count, &nodeIds);

// Use nodeIds

::CoTaskMemFree(nodeIds);

// GetNodeIds just gets the count and returns S_OK
ULONG number = 0;
warning->GetNodeIds(&number, NULL);

Requirements

Requirement	Value
Minimum supported client	Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server	None supported
Header	IACom.h (also requires IACom_i.c)
DLL	IACom.dll