DDE API

View

AddCompView

Syntax

AddCompView

Description

Composite View to current view.

Parameters

None

Pre-requisites

None

Return Values

RemoveCompView

Syntax

RemoveCompView

Description

Remove Composite View to current view.

Parameters

None

Pre-requisites

None

Return Values

File Operations

ChangeFile

Syntax

ChangeFile

Description

Change the file

Parameters

None

Pre-requisites

None

Return Values

CloseFile

Syntax

CloseFile

Description

Close the currently selected file

Parameters

None

Pre-requisites

None

Return Values

GetCurrentFile

Syntax

GetCurrentFile

Description

Get the hash of the current file

Parameters

None

Pre-requisites

None

Return Values

GetFilename

Syntax

GetFileName

Description

Get the filename of a hash

Parameters

None

Pre-requisites

None

Return Values

GetOpenFiles

Syntax

GetOpenFiles

Description

Get the list of hashes, of open files. This will return any files opened. Any open file which is 'unsaved' is labeled as '<Untitled>'.

Parameters

None

Pre-requisites

None

Return Values

NewFile

Syntax

NewFile

Description

Create a new file and return a hash

Parameters

None

Pre-requisites

None

Return Values

OpenFile

Syntax

OpenFile

Description

This function will open a filename in StoryServer.

Parameters

None

Pre-requisites

None

Return Values

SaveFile

Syntax

SaveFile

Description

Saves current file

Parameters

None

Pre-requisites

None

Return Values

AddFileToMenu

Syntax

AddFileToMenu

Description

Add a file to Launcher menu. Undocumented.

Parameters

None

Pre-requisites

None

Return Values

General Operations

GetFolderOutline

Syntax

GetFolderOutline

Description

Call this function (GetVersion) for version-compatibility prior to further DDE calls.

Parameters

None

Pre-requisites

Requires a file to be opened prior.

Return Values

The return is in pairs

Pair ID Output Comments

1

Level

int64

2

Folder ID

int64

GetVersion

Syntax

GetVersion

Description

Call this function (GetVersion) for version-compatibility prior to further DDE calls.

Parameters

None

Pre-requisites

None

Return Values

The GetVersion() method returns the StoryServer API version number.

View

Syntax

AddColumnToView

Description

Parameters

None

Pre-requisites

None

Return Values

AddFolderToView

Syntax

AddFolderToView

Description

Parameters

None

Pre-requisites

None

Return Values

ChangeView

Syntax

ChangeView

Description

Parameters

None

Pre-requisites

None

Return Values

CreateView

Syntax

CreateView

Description

Parameters

None

Pre-requisites

None

Return Values

DeleteView

Syntax

DeleteView

Description

Parameters

None

Pre-requisites

None

Return Values

GetViewColumns

Syntax

GetViewColumns

Description

Parameters

None

Pre-requisites

None

Return Values

GetViewFolders

Syntax

GetViewFolders

Description

Parameters

None

Pre-requisites

None

Return Values

GetViewNames

Syntax

GetViewNames

Description

Parameters

None

Pre-requisites

None

Return Values

GetViews

Syntax

GetViews

Description

Parameters

None

Pre-requisites

None

Return Values

GetViewTLIs

Syntax

GetViewTLIs

Description

Parameters

None

Pre-requisites

None

Return Values

Syntax

Syntax

ClrNotify

Description

Parameters

None

Pre-requisites

None

Return Values

GetChanges

Syntax

GetChanges

Description

Parameters

None

Pre-requisites

None

Return Values

GetDeletions

Syntax

GetDeletions

Description

Parameters

None

Pre-requisites

None

Return Values

GetLastResult

Syntax

GetLastResult

Description

Parameters

None

Pre-requisites

None

Return Values

LastResult

Syntax

LastResult

Description

Parameters

None

Pre-requisites

None

Return Values

SetNotify

Syntax

SetNotify

Description

Parameters

None

Pre-requisites

None

Return Values

Copy and Paste

Syntax

CopyOLEItem

Description

Parameters

None

Pre-requisites

None

Return Values

GetSelection

Syntax

GetSelection

Description

Parameters

None

Pre-requisites

None

Return Values

PasteOLEItem

Syntax

PasteOLEItem

Description

Parameters

None

Pre-requisites

None

Return Values

Folder

Syntax

CreateFolder

Description

Parameters

None

Pre-requisites

None

Return Values

GetFolderAutoAssignRules

Syntax

GetFolderAutoAssignRules

Description

Parameters

None

Pre-requisites

None

Return Values

GetFolderItems

Syntax

GetFolderItems

Description

Parameters

None

Pre-requisites

None

Return Values

GetFolderName

Syntax

GetFolderName

Description

Parameters

None

Pre-requisites

None

Return Values

GetFoldersByName

Syntax

GetFoldersByName

Description

Parameters

None

Pre-requisites

None

Return Values

GetFoldersByType

Syntax

GetFoldersByType

Description

Parameters

None

Pre-requisites

None

Return Values

GetFolderType

Syntax

GetFolderType

Description

Parameters

None

Pre-requisites

None

Return Values

GetFolderValues

Syntax

GetFolderValues

Description

Parameters

None

Pre-requisites

None

Return Values

SetFolderName

Syntax

SetFolderName

Description

Parameters

None

Pre-requisites

None

Return Values

SetFolderValues

Syntax

SetFolderValues

Description

Parameters

None

Pre-requisites

None

Return Values

Items

SetFolderValues

Syntax

CreateItem

Description

Parameters

None

Pre-requisites

None

Return Values

GetItemFolders

Syntax

GetItemFolders

Description

Parameters

None

Pre-requisites

None

Return Values

GetItemParents

Syntax

GetItemParents

Description

Parameters

None

Pre-requisites

None

Return Values

GetItemSubs

Syntax

GetItemSubs

Description

Parameters

None

Pre-requisites

None

Return Values

GetItemType

Syntax

GetItemType

Description

Parameters

None

Pre-requisites

None

Return Values

InsertItem

Syntax

InsertItem

Description

Parameters

None

Pre-requisites

None

Return Values

RemoveItem

Syntax

RemoveItem

Description

Parameters

None

Pre-requisites

None

Return Values

SetItemText

Syntax

SetItemText

Description

Parameters

None

Pre-requisites

None

Return Values

Calendar Items

Syntax

GetDayviewItemTime

Description

Parameters

None

Pre-requisites

None

Return Values

SetCalDate

Syntax

SetCalDate

Description

Parameters

None

Pre-requisites

None

Return Values

Phonebook

ShowPhoneBookItem

Syntax

ShowPhoneBookItem

Description

Parameters

None

Pre-requisites

None

Return Values

GetPopupValues

Syntax

GetPopupValues

Description

Parameters

None

Pre-requisites

None

Return Values

Last updated: 2019 Jan 19th 05:08:06