SketchUp SDK
|
#include <wtypes.h>
#include <stddef.h>
Go to the source code of this file.
Macros | |
#define | SU_INVALID { 0 } |
Use this macro to initialize new reference variables. e.g. SUStringRef str = SU_INVALID;. More... | |
#define | SUIsInvalid(VARIABLE) (VARIABLE).ptr == 0 |
Use this macro to test for invalid SU variables. e.g. if (SUIsInvalid(result)) return false;. More... | |
#define | SUSetInvalid(VARIABLE) (VARIABLE).ptr = 0 |
Use this macro to set a reference invalid. More... | |
#define | SUAreEqual(VARIABLE1, VARIABLE2) ((VARIABLE1).ptr == (VARIABLE2).ptr) |
Use this macro to check if two references are equal. More... | |
Typedefs | |
typedef wchar_t | unichar |
A platform-independent UTF16 type. More... | |
Enumerations | |
enum | SUResult { SU_ERROR_NONE = 0, SU_ERROR_NULL_POINTER_INPUT, SU_ERROR_INVALID_INPUT, SU_ERROR_NULL_POINTER_OUTPUT, SU_ERROR_INVALID_OUTPUT, SU_ERROR_OVERWRITE_VALID, SU_ERROR_GENERIC, SU_ERROR_SERIALIZATION, SU_ERROR_OUT_OF_RANGE, SU_ERROR_NO_DATA, SU_ERROR_INSUFFICIENT_SIZE, SU_ERROR_UNKNOWN_EXCEPTION } |
Defines return values used by most API functions. More... | |
#define SU_INVALID { 0 } |
Use this macro to initialize new reference variables. e.g. SUStringRef str = SU_INVALID;.
#define SUAreEqual | ( | VARIABLE1, | |
VARIABLE2 | |||
) | ((VARIABLE1).ptr == (VARIABLE2).ptr) |
Use this macro to check if two references are equal.
#define SUIsInvalid | ( | VARIABLE | ) | (VARIABLE).ptr == 0 |
Use this macro to test for invalid SU variables. e.g. if (SUIsInvalid(result)) return false;.
#define SUSetInvalid | ( | VARIABLE | ) | (VARIABLE).ptr = 0 |
Use this macro to set a reference invalid.
typedef wchar_t unichar |
A platform-independent UTF16 type.
enum SUResult |
Defines return values used by most API functions.
Enumerator | |
---|---|
SU_ERROR_NONE |
Indicates success. |
SU_ERROR_NULL_POINTER_INPUT |
A pointer for a required input was NULL. |
SU_ERROR_INVALID_INPUT |
An API object input to the function was not created properly. |
SU_ERROR_NULL_POINTER_OUTPUT |
A pointer for a required output was NULL. |
SU_ERROR_INVALID_OUTPUT |
An API object to be written with output from the function was not created properly. |
SU_ERROR_OVERWRITE_VALID |
Indicates that an input object reference already references an object where it was expected to be SU_INVALID. |
SU_ERROR_GENERIC |
Indicates an unspecified error. |
SU_ERROR_SERIALIZATION |
Indicate an error occurred during loading or saving of a file. |
SU_ERROR_OUT_OF_RANGE |
An input contained a value that was outside the range of allowed values. |
SU_ERROR_NO_DATA |
The requested operation has no data to return to the user. This usually occurs when a request is made for data that is only available conditionally. |
SU_ERROR_INSUFFICIENT_SIZE |
Indicates that the size of an output parameter is insufficient. |
SU_ERROR_UNKNOWN_EXCEPTION |
An unknown exception occurred. |