IStringHandle

The IStringHandle class is a wrapper for a string handle.

AIX Considerations

IStringHandle is an alias for a void*.

OS/2 Considerations

IStringHandle is an alias for the OS/2 Programmer's Toolkit type HSTR.

Windows Considerations

IStringHandle is an alias for a void*.


IStringHandle - Member Functions and Data by Group

Constructors & Destructor

You can construct objects of this class.


[view class]
IStringHandle
public:
IStringHandle(Value value = 0)

You can construct objects of this class from a string handle (a value of type IStringHandle::Value), which defaults to 0.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Diagnostics

Use these members to obtain diagnostic information.


[view class]
asDebugInfo
public:
IString asDebugInfo() const

Returns the handle as a string containing diagnostic information.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
asString
public:
IString asString() const

Returns the handle as a string of form nnnn.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
asUnsigned
public:
unsigned long asUnsigned() const

Returns the handle value as an unsigned long value.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Type Conversions

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


[view class]
operator Value
public:
operator Value() const

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


IStringHandle - Type Definitions


[view class]
Value
typedef void * Value

This type definition defines Value to be an unsigned long on the OS/2 platform. On all other platforms Value is defined to be a void*.

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


IStringHandle - Inherited Member Functions and Data

Inherited Public Functions

Inherited Public Data

Inherited Protected Functions

Inherited Protected Data