tagSUJavaScriptInvokeHookData Struct Reference

#include <ShapeUpAPI.h>

List of all members.

Public Attributes

SUHookData hd

const char * name

DWORD flags

size_t argc

const SUJavaScriptArgument * args

size_t retc

SUJavaScriptArgument * rets

Detailed Description

This is an example of how to construct the return values.

    // Let's return 2 values, a shape and a string, to the calling JavaScript
    // (Error handling omitted for simplicity)

    SUJavaScriptInvokeHookData *args; // From the hook function
    SUHANDLE hWorkspace;              // From the hook function

    args->retc = 2;
    ShapeUp_Allocate(sizeof(SUJavaScriptArgument) * args->retc, (void**)&args->rets);

    args->rets[0].type = DT_SUHANDLE;
    args->rets[0].handleVal = SUWorkspace(hWorkspace).GetTheme(0).GetShape(0);

    args->rets[1].type = DT_STRING;
    args->rets[1].stringVal = ShapeUp_DuplicateString("A string");

The return value is by default treated as an Array of values, even if there is only one element. To avoid this if the intention is just to return one value, set the flags member of SUJavaScriptInvokeHookData to include JSIHDF_TREATRETURNASSINGLEVALUE.

The following return values are supported:

int
double
null terminated char*
boolean
COLORREF
SUHANDLE to a theme
SUHANDLE to a shape

Note:: It's important to use ShapeUp_Allocate() or one of its relatives to allocate memory for the return values since ShapeUp will deallocate the structure.

The hook function can return any of:

SURESULT_OK to indicate success.
SURESULT_E_NOTIMPLEMENTED to indicate the the call was not handled.
SURESULT_E_ILLEGALPARAM to indicate that the parameters were incorrect for this method.