CDSetDocumentSetting

Applies To:

ChemDraw Menu Extensions Interface:  Access Functions

Description:

Sets setting data for the given document and the given key.

Syntax:

long CDAPI CDSetDocumentSetting( long documentToken,
                                                                char *settingKey,
                                                                HANDLE settingData,
                                                                long dataLength
);

documentToken a document token representing the document of interest, as provided to the DLL in a GetSubmenuItemName, GetSubmenuItemState or DoSubmenuChoice call.
settingKey a null-terminated, segmented string of the form "Company:DatumName\0" indicating the setting to set.
settingData a handle containing the setting data.
dataLength the size of the setting data handle, in bytes.

Returns a long indicating success (0) or failure (!0) of the function.

Remarks:

The setting data will be stored with the document. If a setting with the same settingKey already exists in the document, the setting data will be replaced with the new setting data.

This function must have ordinal number 11 in the Import Definition File.

The DLL is responsible for deallocating the handle after the call returns.

If an error is returned, the DLL may call CDGetApplicationErrorString for a string explaining the error.

Example:

See Also:

GetSubmenuItemName, GetSubmenuItemState, DoSubmenuChoice, CDGetApplicationErrorString


2005 CambridgeSoft Corporation. All Rights Reserved. Privacy Statement
Tel  800 315-7300 / 617 588-9300     Fax  617 588-9390     Email   info@cambridgesoft.com
CambridgeSoft Corporation, 100 CambridgePark Drive, Cambridge, MA 02140 USA