Sets one of the neig types in the neig filter to be filtered.

    GSErrCode ACAPI_Interface (
        APIIo_SetNeigFilterID,
        API_NeigFilter*     neigFilter,
        API_NeigID          neigID
    );

 

Parameters

neigFilter

[in] The neig filter.

neigID

[in] Neig type to set for filtering.

 

Return Values

NoError

The function has completed with success.

APIERR_BADPARS

neigFilter is nullptr

For other common API errors see the API Errors document.

 

Remarks

This function is used to set one of the neig types to be filtered during a user input. More information about neig filtering can be found at the remarks section of the APIIo_InitNeigFilterID function.

To clear an installed filter use the APIIo_ClearNeigFilterID function.

 

Example

See APIIo_DrawRubberLineID for example of using input neig filters.

 

Requirements

Version: API 2.1 or later

Header: APIdefs_Interface.h

 

See Also

API_NeigFilter, API_NeigID,
APIIo_ClearNeigFilterID, APIIo_InitNeigFilterID,
ACAPI_Interface, API Functions