# coyote: CGBITGET

- coyote/Utilities
- [Source code]

Description

      The program is used to obtain the value of a particular bit in an integer number.

Categories

      Utilities

Returns

      The function returns the bit value (0 or 1) of a specified bit in a supplied number.

Params

      number: in, required, type=integer
           The number from which the bit value is obtained. It should be a scalar integer.
           If it is not, it is converted to a scalar integer by rounding.
      bit: in, required, type=integer
           The number of the bit you are interested in. A value between 0 and 63.
           If not supplied, all 64 bit values of the number are returned. May be
           an array of bit numbers.

Keywords

      silent: in, optional, type=boolean, default=0
           If set, suppresses informational messages regarding rounding operations.

Examples

      Here is how to use this program::
         IDL> !X.Style = 5
         IDL> Print, cgBitGet(!X.Style, 2)
              1

Author

      FANNING SOFTWARE CONSULTING::
         David W. Fanning
         1645 Sheely Drive
         Fort Collins, CO 80526 USA
         Phone: 970-221-0438
         E-mail: david@idlcoyote.com
         Coyote's Guide to IDL Programming: http://www.idlcoyote.com

History

      Change History::
         Written by David W. Fanning, 14 June 2006.

Copyright

      Copyright (c) 2006-2014, Fanning Software Consulting, Inc.