### IBitmapHandle

  The IBitmapHandle class accesses and manages bitmap resources through reference-counting. Reference-counting allows the system to use one bitmap in multiple places; the library maintains the lifetime of this bitmap until all users are finished with it.

#### AIX Considerations

  Use IBitmapHandle in system calls where the X Toolkit Pixmap type is required.

#### OS/2 Considerations

  Use IBitmapHandle in system calls where the OS/2 Programmer's Toolkit type HBITMAP is required.

#### Windows Considerations

  Use IBitmapHandle in system calls where the Win32 SDK type HBITMAP is required.

### IBitmapHandle - Member Functions and Data by Group

### Constructors & Destructor

Use the functions in this group to construct, destroy, and copy objects of this class.

The library provides the copy constructor and destructor to keep track of references to the bitmap so its resources can be freed when no longer needed.

~IBitmapHandle

      public:
      ~IBitmapHandle()

  Destroys the IBitmapHandle object.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

IBitmapHandle
  This constructor creates an object of class IBitmapHandle.

  Overload 1

      public:
      IBitmapHandle(const IBitmapHandle& aHandle)

  You can use this constructor to create objects of this class from an existing IBitmapHandle object.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

  Overload 2

      public:
      IBitmapHandle(Value value = 0)

  You can use this constructor to create an object of this class from a bitmap handle (a value of type IBitmapHandle::Value), which defaults to 0.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

### Assignment Operator

Use the operator in this group to assign one bitmap handle to another.

operator =

      public:
      IBitmapHandle& operator =(const IBitmapHandle& aHandle)

  Assigns the value of one bitmap handle to another while managing the references to the two handles. If the reference count of the bitmap previously associated with the target handle reaches 0, the bitmap is destroyed.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

### Diagnostics

Use the functions in this group to obtain diagnostic information.

asDebugInfo

      public:
      IString asDebugInfo() const

  This function returns the handle as a string containing diagnostic information.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

asString

      public:
      IString asString() const

  This function returns the handle as a string of form nnnn.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

asUnsigned

      public:
      unsigned long asUnsigned() const

  This function returns the handle value as an unsigned long value.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

fhandle

      protected:
      Value fhandle

  The value of the pointer to the bitmap handle.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

### Type Conversions

Use the type conversion operators to convert objects of this class to a different type.

operator Value

      public:
      operator Value() const

  This function returns the handle as its operating system dependent type. Use this operator when you use the handle object as an argument to an operating system function.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

### IBitmapHandle - Type Definitions

Value

      typedef void * Value

  Variation 1

      typedef void * Value

Supported Platforms

  Windows | OS/2 | AIX
  Yes | No | No

  Variation 2

      typedef unsigned long Value

Supported Platforms

  Windows | OS/2 | AIX
  No | Yes | No

### IBitmapHandle - Inherited Member Functions and Data

#### Inherited Public Functions

  - None

#### Inherited Public Data

  - None

#### Inherited Protected Functions

  - None

#### Inherited Protected Data

  - None