Check a connection to Stickies

Return values

000 OK pong
997 OK pong, with events

Remarks

Check that you are able to send commands to, and receive a reply from Stickies. This command will have no other effect on Stickies. If the client has successfully registered for events with Stickies, then the second return string will be recieved. Otherwise it will be the former.

Create a new sticky, with the default style

Return values

000 OK created: <id>

Remarks

With no content specified, a new blank sticky is created. Otherwise, the sticky will have the contents specified at the end of the command. The sticky id is supplied in the reply, so that additional attributes can be set if required.

Closes the specified desktop sticky

Return values

000 OK closed

Remarks

Removes the sticky from the desktop, and places it in the Closed category, so that the user is able to restore it if they choose.

Permanently removes the specified desktop sticky

Return values

000 OK deleted

Remarks

The sticky is completely removed, and is not added to the Closed category

Open the Manage dialog

Return values

000 opened
997 it's already open

Remarks

Open the Manage dialog

Close the manage dialog

Return values

000 closed
998 it's already closed

Remarks

Close the manage dialog

Add an item to the right-click menu of each sticky which generates an API event when clicked

Return values

000 added
996 Menu command already exists

Remarks

Create a hook back to your code from a sticky with this command. The menu text you supply will be added as an item to the bottom of each sticky menu, and when the user selects that menu item, an event with the code "command" as specified here is sent to all API clients which have registered for events. The command has the identifier of the sticky for which the user caused the menu to show in it. If the command specified already exists as a menu in Stickies, no changes are made, and the error is returned.

Remove an item previously added to the right-click menu of each sticky

Return values

000 removed
997 Not found to remove

Remarks

Removes a menu command previously added by the "do stickymenuadd" command. As the item has then been removed, it can no longer be clicked by the user, so no more events with the specified code will be received.

Add an item to the task-tray menu of Stickies which generates an API event when clicked

Return values

000 added
996 Menu command already exists

Remarks

Create a hook back to your code from Stickies with this command. The menu text you supply will be added as an item to the main Stickies menu, and when the user selects that menu item, an event with the code "command" as specified here is sent to all API clients which have registered for events. If the command specified already exists as a menu in Stickies, no changes are made, and the error is returned.

Remove an item previously added to the task-tray menu of Stickies

Return values

000 removed
997 Not found to remove

Remarks

Removes a menu command previously added by the "do stickiesmenuadd" command. As the item has then been removed, it can no longer be clicked by the user, so no more events with the specified code will be received.

Request notification of events within Stickies

Return values

000 will send events your way
997 already registered

Remarks

The command adds the calling application to the list of windows to which Stickies will send a notification when an event within Stickies occurs. A list of events can be found here. The calling application must fill in the window handle parameter of the SendMessage Windows API call, so that Stickies can send events to that window when they occur.

If at any point Stickies tries to send a message to your application and fails, then it will be removed from its list of API clients.

Cease sending of events

Return values

000 no more events will be sent
997 not registered in the first place

Remarks

No more events will be sent from Stickies to your application. Making this call as your application exits is neat, but not essential, as Stickies will stop trying to send events once it's tried to do so once and failed.

Hide all desktop stickies from view

Return values

000 hidden

Remarks

All desktop stickies are hidden, and the tray icon changes to indicate that this is the case

Show all desktop stickies following them being hidden

Return values

000 shown

Remarks

All desktop stickies are shown again, and the tray icon changes back to normal.

Set the specified desktop sticky rolled up.

Return values

000 rolled
997 unable to roll up

Remarks

If the skin does not support being rolled up, the error will be returned

Set the specified desktop sticky unrolled.

Return values

000 unrolled

Remarks

Ensures that the specified sticky is not rolled up

Performs a backup of all Stickies data to the specified path

Return values

000 backup taken
997 Failure during backup

Remarks

Creates the destination directory if it does not exist, and then copies all live data into that location. Any files which are already in that location with the same name will be overwritten without prompting

Send the specified sticky to sleep

Return values

000 slept
995 not found

Remarks

Moves a desktop sticky to the sleeping list, to wake at the specified time, which is in seconds since midnight, Jan 1st 1970 UTC. For example, 02:00 on the 12th November 2009 will be 1257991200. Options is three characters, each is 0 or 1, which refer to "make sound", "on top" and "trigger alarm", eg specify "111" to do all three, or "010" to make no noise, but be on top

Set the specified sticky to recurr

Return values

000 slept
995 not found

Remarks

Moves a desktop sticky to the sleeping list, to wake repeatedly from the firstwake to the lastwake, according to the schedule:

Type	type	hours	minutes	days
Daily	1	hour	minute	n/a
Weekly	2	hour	minute	mon:1 tue:2 wed:4 - sum those
Monthly (day of month)	3	hour	minute	day
Yearly	4	hour	minute	day + 100*month
Monthly (position)	5	hour	minute	day of week + 100*code
Every	6	n/a	quantity	0=mins, 1=hours, 2=days, 3=weeks

The <options> are the same as for the "do sleep" command detailed above

Wakes the specified sticky

Return values

000 woken
995 not found
997 unable to wake

Remarks

Move a sleeping or recurring sticky to the desktop. Recurring stickies will no longer recurr once woken with this command

Creates a new sleeping sticky from the encoded string

Return values

000 OK created: <id>

Remarks

Create a new sleeping sticky from the encoded string. This must be correctly formatted, see the return from the "get sleeping <id> encoded" command for an example of this format.

Brings all stickies to the top of the z-order

Return values

000 done

Remarks

This performs the same action as single-clicking the tray icon

Starts the alarm on the specified sticky

Return values

000 alarmed
995 not found

Remarks

The sticky will start to flash / jiggle / sound as per the user's specification in the Options dialog

Stops the alarm on the specified sticky

Return values

000 quieted
995 not found

Remarks

The specified sticky will no longer be alarming

Identify a desktop sticky from its window handle

Return values

001 <id>
995 not found

Remarks

Searches the current Desktop stickies for one which has the specified window handle, and returns the id of the sticky. The window handle must be a decimal number, and is the return value from API commands such as ::FindWindow()

Sync with server and add any new friends found to the Friend list

Return values

000 done

Remarks

Does the same as clicking the "Get New Friends" button, and adds new Friends to a new group at the bottom of the Friend list

Save the main Stickies data file immediately, ensuring any last-minute changes have been written to disk.

Return values

000 saved
995 problem saving

Remarks

Does the same as pressing control-shift-s in a sticky, but doesn't display the balloon tray hint

Send the desktop sticky identified over the network to another instance of Stickies.

Return values

000 saved
994 unable to send
995 not found
997 unrecognised netsend method

Remarks

The <address> can be either an IP address, or a hostname. If you need to send the sticky to a different port, then add a colon, and then the port number, eg 172.168.16.128:8874

Set the Stickies skin to be the file specified

Return values

000 set
997 unable to load file
997 forbidden by GPO

Remarks

The Stickies skin is set to the pathname in the command, and all stickies are refreshed with the new look. The skin can be either an ini file, or a ssk. A failure will mean the default skin is loaded, and the 997 error message returned.

Get the loaded Stickies skin file

Return values

001 <skinfile_path>

Remarks

Return the path to the currently loaded skin. If this is blank, then the default skin is loaded.

Get the version of Stickies which is running

Return values

001 <version>

Remarks

Return the Stickies version, in the format "Stickies vX.XX"

Get the path Stickies is currently using for data storage

Return values

001 <path>

Remarks

This permits access to the path which is displayed at the bottom of the About dialog in Stickies. This location is where Stickies stores all data files, and also the log file if one is being written.

Get the title of the specified desktop sticky

Return values

001 <current title>

Remarks

Return the title of the specified desktop sticky. The return value is converted to ANSI and so unicode characters will not be correct.

Get the source of the specified desktop sticky

Return values

001 <current source>

Remarks

Return the source of the specified desktop sticky

Get the colour of the specified desktop sticky

Return values

001 <red,green,blue>

Remarks

Return the colour of the specified desktop sticky. The returned string is three comma-separated numbers which give the red, green and blue values.

Get the contents of the specified desktop sticky

Return values

001 <text>

Remarks

Return the text of the specified desktop sticky. The returned string is plain text, and contains no formatting

Get the screen location of the specified desktop sticky

Return values

001 <x,y>

Remarks

Return the location in virtual screen co-ordinates of the specified desktop sticky. This means that one or both of the values may be negative.

Get the dimensions of the specified desktop sticky

Return values

001 231x89

Remarks

Return the size in pixels of the specified desktop sticky. If the sticky is rolled, the current height of the just the title bar is returned, not the full height when the sticky is unrolled.

Get the always-on-top status of the specified desktop sticky

Return values

001 0
001 1

Remarks

If the sticky is on-top, then the value 1 is returned, otherwise 0.

Get the value of the 'userstring1' attribute of the specified desktop sticky

Return values

001 <value>

Remarks

The 'userstring1' value is not used by Stickies in any way, and is provided for third party extentions

Returns whether the specified desktop sticky is hidden from view

Return values

001 0
001 1

Remarks

The return value 0 means the sticky is visible on screen. The return value 1 means the sticky is currently hidden from view.

Returns whether the specified desktop sticky has 'ghost' mode enabled

Return values

001 0
001 1

Remarks

The return value 0 means the sticky is 'normal'. The return value 1 means the sticky cannot be interacted with by the mouse, although it is visible.

Returns the transparency value of the specified desktop sticky

Return values

001 <value>

Remarks

The value is a percentage, between 0 and 100. Either 0 or 100 means the sticky is opaque. Lower percentages mean the sticky is more transparent.

Returns the last modification date of the specified desktop sticky

Return values

001 <time> <year> <month> <day> <hours> <minutes> <seconds> <dayofweek>
997 no data

Remarks

The first of the values returned, time, is the number of seconds since Jan 01, 1970, and as such can be used to specify a unique point in time, and be used for relative calculations. Add 3600 to the value to get the time an hour later. However, be wary of daylight savings time, leap years and time zones if using this value. The remaining values are provided for convenience and can be reformatted for display. The day of week counts from Sunday, so Sunday = 1, Monday = 2 ... Saturday = 7.

The modified value is updated when these attributes of a sticky are altered:

• text
• title
• source
• colour
• user1
• user2
• user3
• userstring1
• alarm

• size
• width
• read only
• on top
• transparency
• rolled
• attached
• ghost

Returns an encoded string containing all elements of the sticky

Return values

001 <encoded string>

Remarks

The format of the string is the same as is saved to the ini file. For more details on the format, see the "stickies.ini" section of the Stickies help file.

e.g.

<X>0736<Y>0930<WIDTH>352<HEIGHT>60<ONTOP>0<ID>2114B9845C820C5
<READONLY>0<ROLLED>0<TRANSPARENCY>0<CREATED>1210522811<MODIFIED>1210522855
<COLR>91<COLG>103<COLB>91<UTITLE>0073006D0061006C006C002000610079
<SOURCE><ALARM>-1<USER1>1<USER3>1
<RTF>{\rtf1\ansi\ansicpg1252\deff0\deflang2057{\fonttbl{\f0\fdecor\fprq2\fcharset0 Dungeon;}} ^M{\colortbl ;\red171\green182\blue171;}^M\viewkind4\uc1\pard\cf1\f0\fs12 a\par^M}^M

Returns an integer describing the type of sticky, rtf or text

Return values

001 0
001 1
998 sticky not found

Remarks

0 is a RTF (text) sticky, 1 is an image sticky

Returns the Windows handle to the specified sticky

Return values

001 <handle>

Remarks

The return value is a decimal integer, and can be used in Windows API commands such as ::SetWindowPos()

Returns whether the specified Desktop sticky is rolled up

Return values

001 0
001 1
998 sticky not found

Remarks

0 is not rolled up. 1 is rolled up.

Returns the skin file the sticky is using

Return values

001 <path_to_file>
001 <default>
998 sticky not found

Remarks

If the specified sticky is using a custom skin, the path to the file is returned. Otherwise, if the sticky is instead using the default skin, the text <default> is returned.

Return the unicode-formatted title of the specified sticky

Return values

001 <encoded_unicode>

Remarks

The return value is an 8-bit string, so in order to correctly store Unicode characters, an encoding scheme is used which uses four hex characters for each one Unicode character. In order to convert from the encoded string, take each set of four characters in turn, and that's the number of the Unicode character. Similarly, to generate an encoded string, convert each Unicode character in turn to a hex value, and then store those in sequence.

The title "Stickies" has an encoded utitle of: 0053007400690063006B006900650073
This breaks down to the following: 0053 0074 0069 0063 006B 0069 0065 0073
The first character is therefore 0x53, which is 83, which is Unicode (and ASCII) "S"

Return the RTF content of the specified sticky

Return values

001 <rtf>

Remarks

If passed the ID of an image sticky, "empty" RTF will be returned, so check the type with get desktop <id> type first.

Returns an encoded string containing all elements of the sleeping or recurring sticky

Return values

001 <encoded string>

Remarks

The format of the string is the same as is saved to the ini file. For more details on the format, see the "stickies.ini" section of the Stickies help file.

Return the the on-screen position a woken sticky will have

Return values

001 <x,y>

Remarks

When a sleeping sticky wakes, it will appear at a saved position on the screen. This command will return that position.

Returns an encoded string containing all elements of the Closed sticky

Return values

001 <encoded string>

Remarks

The format of the string is the same as is saved to the ini file. For more details on the format, see the "stickies.ini" section of the Stickies help file.

Set the title of the specified desktop sticky

Return values

000 title set

Remarks

Set the title of the specified desktop sticky.

To clear the title, send the command with a space after the word title, eg:

"set desktop 20EFA3490AF2 title "

Set the source of the specified desktop sticky

Return values

000 source set

Remarks

Set the source of the specified desktop sticky

Set the colour of the specified desktop sticky

Return values

000 colour set

Remarks

Set the colour of the specified desktop sticky. The colour should be in the format red,green,blue

Set the contents of the specified desktop sticky

Return values

000 text set

Remarks

Set the contents of the specified desktop sticky. The input is plain text.

Set the position on screen of the specified desktop sticky

Return values

000 position set

Remarks

Set the location in virtual screen co-ordinates of the specified desktop sticky. This means that one or both of the values may be negative.

Set the always-on-top status of the specified desktop sticky

Return values

000 ontop set

Remarks

Set the on-top status of the specified sticky. Pass 0 as the parameter to remove on-top, and pass 1 to set it.

Set the 'userstring1' value of the specified desktop sticky

Return values

000 userstring1 set

Remarks

Sets the specified string parameter as the value of the sticky 'userstring1' value. This value has no relevance to Stickies, but is stored and transmitted over the network. It is provided for third party extentions.

Hides or reveals the specified desktop sticky

Return values

000 hidden set

Remarks

Hidden desktop stickies are just that - they do not appear on the screen although they do appear in a list of desktop stickies. In the Manage dialog, a pair of dark glasses on the icon shows that the sticky has this setting. They cannot be edited, moved or interacted with in any way by the user while hidden.

Sets the specified desktop sticky as non-clickable

Return values

000 ghost set

Remarks

Stickies with 'ghost' mode cannot be clicked on. They appear on the desktop along with all other stickies, and if focus is transferred to one (by control-tabbing to it, or double-clicking it in the Desktop cateogry of the Manage dialog) then it can be used as usual, but no mouse events will be received by it, and instead will "pass though" to whichever window is underneath the sticky in z-order.

Sets the transparency level of the specified desktop sticky

Return values

000 transparency set

Remarks

The value is a percentage - either 0 or 100 will make the sticky completely opaque. 1 is extremely faint, and 99 is only very slightly transparent. Values outside the range 0-100 will be interpreted as opaque.

Sets the style of the specified desktop sticky

Return values

000 style set
997 style not set
996 sticky is read only

Remarks

Sets the specified desktop sticky to the style. If the style specified does not exist, the 997 error is returned.

Sets the unicode-formatted title of the specified sticky

Return values

000 title set
998 sticky not found

Remarks

The <utitle> parameter must be a string formatted in groups of four hex characters - see the remarks for the "get desktop utitle" command for more details on how this should be formatted.

Converts the specified sticky to an image sticky, and loads the file specified

Return values

000 image set
998 sticky not found

Remarks

If the sticky is a RTF one, any text it contains will be discarded. If it is an image one, the current image will be overwritten.

Sets the formatted text of a Desktop RTF sticky

Return values

000 rtf set
997 sticky is image
998 sticky not found

Remarks

If the sticky is an image sticky, the command will fail. Otherwise, the RTF contents will be set.

Sets the id of a sticky

Return values

000 id set
998 sticky not found

Remarks

Changes the unique id of a desktop sticky. Once this command has executed, use the new value to send it any further commands. No error checking is performed - if the id already exists, a duplicate will be created, and further commands which reference the duplicate id may have unpredictable results.

Sets the last modified time of a sticky

Return values

000 modified set
998 sticky not found

Remarks

Sets the last modified time of a Desktop sticky to an absolute point in time.

Sets the skin the one specified Desktop sticky uses

Return values

000 skin set
997 forbidden by GPO
997 unable to set skin
998 sticky not found

Remarks

Alters the skin which the specified sticky uses. The <path> parameter can be either the path to a .ssk or .ini file, or the value <default> which will set the sticky skin back to the user's current default.

Alter the wake time of a sleeping sticky

Return values

000 wake time set

Remarks

The <time> parameter has two formats - either an absolute point in time (eg 1243801800), or a relative one (eg +3600).

The absolute value sets the wake time to be that point in time. The value which starts with the + sets it to be now plus the number of seconds. So, setting +3600 at 16:38 on a day will mean the sticky will wake at 17:38 on that day.

Sets the woken screen position of a sleeping sticky

Return values

000 position set

Remarks

Sleeping stickies have no screen position as they are not visible on the screen. However, they store a screen position for whem they wake up. This command alters that saved screen position without waking the sticky.

Get a list of unique ids of the stickies currently active on the desktop

Return values

001 <id,id,id...>

Remarks

The id of each desktop sticky is separated by a comma. The list is terminated with a comma. Desktop stickies are those which appear in the Desktop category in the Manage dialog.

Get a list of unique ids of the stickies currently sleeping and recurring

Return values

001 <id,id,id...>

Remarks

The id of each desktop sticky is separated by a comma. The list is terminated with a comma.

Get a list of unique ids of the stickies currently in the Closed category

Return values

001 <id,id,id...>

Remarks

The id of each Closed sticky is separated by a comma. The list is terminated with a comma.

Get a friend's IP address/hostname

Return values

001 <address>

Remarks

Get the value of the Address: field for the specified friend. The matching is case-insensitive. If the friend cannot be found, then the friend name supplied is returned.

Get a friend name from their IP address/hostname

Return values

001 <friendname>

Remarks

Get the friend name of the friend which matches the specified address. The matching is case-insensitive. If a friend cannot be found, then the address supplied is returned.

  get uniqueid
Requires: 7.0a

Get the unique string which identifies this instance of Stickies data

Return values

001 <unique_id>

Remarks

This has the same format as a sticky id

Other commands

So, if you've looked at the API, and think you can use it, and would like access to more Stickies internals, drop me a line, I can add the commands you're interested in and send you an updated exe.

Potential commands

• get stifile
• do transmit
• do mailsmtp
• do mailmapi
• do print
• do copytofile
• do movetofile
• do alarm
• do reply
• do setstyle
• do save
• do autosize
• do sendtopalm
• do goaway
• do insertdate
• do formatforreply
• do sendtoppc
• set attached
• get attached
• do startalarm
• do stopalarm
• set readonly
• get readonly
• get created
• set created
• get focus
• do new imagesticky
• set sticky image <filename>
• get selection
• set selection
• set bold
• set italic
• set underline
• set strikethrough
• set bullets
• set cut
• do copy
• do paste
• set align
• do case
• do undo
• do redo
• set colour
• do import
• do startnetwork
• do stopnetwork
• do friends
• do styles
• do about
• do syncnow
• do log
• do revealsecret
• do importppc
• do showhideall
• do rescueoffscreen
• do bringtofront
• also ... very many set/get combinations for each of the Stickies options