Sage-ST

Sage-ST ä
Modsys
Documentation
ClearToNil

  PROCEDURE ClearToNil
             (VAR   SomePointer : SYSTEM.ADDRESS);

  (**
      ClearToNil - Clear a variable to a nil value.

      This routine sets the passed in value to nil.  The only reason
      for this routine currently is that Delphi is throwing out warnings
      in lots of places where we are setting variables to nil after using
      them.  It is warning that the value is never used.  That may be true
      now but we don't want later code changes to suddenly try to use a
      trashed pointer just because it was never nilled.  So its still better
      to nil the variable.  The purpose of this routine is simply to quiet
      the warning message.

      CALLING SEQUENCE -

        ClearToNil (SomePointer);

      ENTRY -

        SomePointer : SYSTEM.ADDRESS
          A pointer that should be set to nil.  Typically this will happen
          after it has been used in a 'Dispose' call.

      EXIT -

        SomePointer : SYSTEM.ADDRESS
          The pointer set to nil.
  *)