PointerType

This article needs a technical review. How you can help.

Draft
This page is not complete.

PointerType represents C pointer.

Syntax

Returns a new CType object describing a new pointer data type.

CType PointerType(
  type
);
Parameters
type
Specifies the type to which the pointer type points. This can be any CType object to declare the new type as a pointer to that type.
Return value

A CType object describing the newly created data type.

Exceptions thrown
TypeError
Thrown if the parameter isn't a CType.
Examples

Creating a type "pointer to 32-bit integer" looks like this:

var intPtrType = new ctypes.PointerType(ctypes.int32_t);

Properties

Property Type Description
targetType CType The type of object the pointer points to. Read only.

Properties inherited from CType

These properties are available on all CType objects.

Property Type Description
name String

The type's name. Read only.

For primitive types, this is just the name of the corresponding C type. For structure and opaque pointer types, this is simply the string that was passed to the constructor. For other function, pointer, and array types, this should be a valid C type expression.

ptr CType Returns a CType representing the data type "pointer to this type". This is the result of calling ctypes.PointerType(the_type). Read only.
size Number

The size of the type, in bytes. This is the same value as the C sizeof. Read only.

Note: ctypes.void_t.size is undefined.

Method overview

Methods inherited from CType

CType array([n])
String toSource()
String toString()

PointerType CData Syntax

CData pointertype();
pointertype is PointerType CType.
Return value

A CData representing the newly allocated pointer.

PointerType CData Properties

Property Type Description
contents CData Reading this property returns a CData object referring to the pointed-to contents of the object. Writing to this value writes the C conversion of the data into the pointed-to memory. If converting the data fails, a TypeError exception is thrown.

Properties inherited from CData

Property Type Description
constructor CType

The data type of the CData object, as a CType. Read only.

Note: This is never ctypes.void_t or an array type with an unspecified length.
value object The JavaScript equivalent of the CData object's value. This will throw a TypeError exception if the value can't be converted.

PointerType CData Method_overview

bool isNull()

Methods inherited from CData

CData address()
String toSource()
String toString()

PointerType CData Methods

isNull()

Determines whether or not the pointer's value is null.

bool isNull();
Parameters

None.

Return value

true if the pointer's value is null, otherwise false.

See Also

Document Tags and Contributors

 Contributors to this page: rolfedh, arai
 Last updated by: rolfedh,