IPointSnapper.UpdateCachedShapes Method

Updates the shapes in the cache for the given token. The token is acquired by calling CacheShape.

[Visual Basic .NET]
Public Sub UpdateCachedShapes ( _
    ByVal token As Integer, _
    ByVal pShapes As IGeometryBag _
)

[C#]
public void UpdateCachedShapes (
    int token,
    IGeometryBag pShapes
);

[C++]
HRESULT UpdateCachedShapes(
  long token,
  IGeometryBag* pShapes
);

[C++]
Parameters
token [in]
  token is a parameter of type long
pShapes [in]
  pShapes is a parameter of type IGeometryBag

Product Availability

Errors Returned

COMException is thrown when the geometry bag is null or empty or the token is invalid.

Remarks

UpdateCachedShapes updates the geometries associated with a given token.  The snap cache is cleared when a call to UpdateCachedShapes is made; the next subsequent call to Snap will build the cache.

See Also