![]() |
SoSharedLibDefs.h File ReferenceDetailed DescriptionThe ExtendScript header file used to implement external objects.
Definition in file SoSharedLibDefs.h.
Go to the source code of this file.
Define Documentation
Bad argument list (TypeError).
Definition at line 42 of file SoSharedLibDefs.h. Referenced by acceptBoolean(), appendString(), getAverage(), makeArray(), objectCall(), paramAny(), paramBool(), paramFloat64(), paramInt32(), paramString(), and paramUInt32().
Out of memory.
Definition at line 44 of file SoSharedLibDefs.h. Referenced by built(), paramAny(), and paramString().
This is the C header file which you need to write DLLs that ExtendScript can load at runtime. The list of runtime errors. Errors with negative values are considered fatal and cannot be caught by Javascript. This is a subset of all possible runtime errors. Please do not use other error codes. No error Definition at line 32 of file SoSharedLibDefs.h. Referenced by acceptBoolean(), appendString(), built(), createArray(), getAverage(), makeArray(), myScript(), objectCall(), objectFinalize(), objectGet(), objectInitialize(), objectToString(), objectValueOf(), paramAny(), paramBool(), paramFloat64(), paramInt32(), paramString(), paramUInt32(), and setVersion().
Type mismatch (TypeError).
Definition at line 64 of file SoSharedLibDefs.h. Referenced by objectCall(), paramAny(), paramBool(), paramFloat64(), paramInt32(), paramString(), and paramUInt32().
A boolean value is either interpreted as false (if the value is zero) or true (if the value is nonzero). The field is intval, the value is 0 or 1. Definition at line 118 of file SoSharedLibDefs.h. Referenced by acceptBoolean(), paramAny(), paramBool(), and stringize().
A double floating point value (64 bits). The field is fltval. Definition at line 121 of file SoSharedLibDefs.h. Referenced by getAverage(), objectCall(), objectGet(), paramAny(), paramFloat64(), and stringize().
An integer value is a signed 32-bit quantity. The field is intval. Definition at line 139 of file SoSharedLibDefs.h. Referenced by objectCall(), objectGet(), paramAny(), paramInt32(), and stringize().
An object value is a pointer to a LiveObject. The field is hObject. A LiveObject pointer returned as a function result is not released Definition at line 132 of file SoSharedLibDefs.h.
An object value is a pointer to a LiveObject. The field is hObject. A LiveObject pointer returned as a function result is released Definition at line 136 of file SoSharedLibDefs.h.
A script is an executable string. You can return a script, which causes ExtendScript to run the returned string as a JavaScript and to return from the function call with whatever the evaluation of the string returned. The field is string, and if you want ExtendScript to release a returned memory pointer, implement FreeMem(). Definition at line 149 of file SoSharedLibDefs.h. Referenced by createArray(), makeArray(), and myScript().
A string value. If you provide a string value, define the entry point FreeMem() in your DLL so ExtendScript can free your memory after use. Strings are supposed to be encoded in UTF-8 and to be null-terminated. The field is string, and if you want ExtendScript to release a returned memory pointer, implement FreeMem(). Definition at line 128 of file SoSharedLibDefs.h. Referenced by acceptBoolean(), appendString(), built(), objectCall(), objectFinalize(), objectGet(), objectPut(), objectToString(), objectValueOf(), paramAny(), paramString(), and stringize().
An unsigned integer value is an unsigned 32-bit quantity. The field is intval. Definition at line 142 of file SoSharedLibDefs.h. Referenced by paramAny(), paramUInt32(), and stringize().
The possible VariantData data types. Undefined means that this value is not defined. ExtendScript passes this value in if an argument is supplied as "undefined". If a function should not return any value, the return value is Undefined as well. The return value for a function is always preset to Undefined. Definition at line 114 of file SoSharedLibDefs.h. Referenced by objectCall(), paramAny(), paramBool(), paramFloat64(), paramInt32(), paramString(), paramUInt32(), and stringize().
Typedef Documentation
Definition at line 188 of file SoSharedLibDefs.h.
All functions need to be coded in the same way, following the function definition below. ExtendScript passes in an array of arguments as VariantData, and supplies a VariantData element preset to Undefined for the return value. You should return any error code. If the function suceeds, the return value is kESErrOK. Definition at line 162 of file SoSharedLibDefs.h.
Definition at line 105 of file SoSharedLibDefs.h.
|
![]() |
|