IPointSnapper.RemoveCachedShapes Method

Remove the shape from the cache. The token is acquired by calling CacheShape.

[Visual Basic .NET]
Public Sub RemoveCachedShapes ( _
    ByVal token As Integer _
)

[C#]
public void RemoveCachedShapes (
    int token
);

[C++]
HRESULT RemoveCachedShapes(
  long token
);

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

Product Availability

Errors Returned

ComException Token is not valid.

Remarks

RemoveCachedShapes clears any shapes associated with a given token from the snapping cache.  An exception is thrown when an invalid token provided.  The snap cache is cleared when a call to RemoveCachedShapes is made; the next subsequent call to Snap will build the cache.

See Also