B.1 OLE Function Error Codes

All OLE functions of the OLESTATUS data type return one of the following enumerated error codes, as defined in OLE.H. If no errors occur, OLE_OK is returned. For information on the error codes returned by OLE functions, see Chapter 8, "The OLE Server DLL," and Chapter 9, "The OLE Client DLL."

The return codes listed here are in ascending order, by value.

Code Value Description

OLE_OK 0 The function encountered no errors and completed successfully.
OLE_WAIT_FOR_RELEASE 1 The client or server application initiated a command, now it must wait for the object to be released. The application should keep dispatching messages until the release callback receives OLE_RELEASE.
OLE_BUSY 2 The client application tried to initiate an asychronous operation while another asynchronous operation was in progress.
OLE_ERROR_PROTECT_ONLY 3 The OLE function was called in real mode, which is not supported.
OLE_ERROR_MEMORY 4 Either the OLE DLLs or the server application could not allocate or lock memory.
OLE_ERROR_STREAM 5 An OLE stream error occurred; this is generally caused by a failure in the client application's Get or Put callback functions.
Code Value Description

OLE_ERROR_STATIC 6 A non static object was expected by the OLE libraries.
OLE_ERROR_BLANK 7 There is critical data missing; this is generally caused by a user terminating the creation of an object. (The application gets an OLE-CLOSED notification and any subsequent calls to OLE APIs on this object will return this message.)
OLE_ERROR_DRAW 8 An error occurred while drawing the object.
OLE_ERROR_METAFILE 9 The metafile specified is invalid.
OLE_ERROR_ABORT 10 The client application chose to cancel the metafile drawing.
OLE_ERROR_CLIPBOARD 11 The OLE libraries were unable to obtain the necessary data from the clipboard; this is generally caused by the client application's failure to get or set the clipboard data.
OLE_ERROR_FORMAT 12 The requested format is not available.
OLE_ERROR_OBJECT 13 The object is not valid.
OLE_ERROR_OPTION 14 An invalid option occurred (link update or rendering of an object).
OLE_ERROR_PROTOCOL 15 An invalid protocol was specified as part of a parameter to an OLE API.
OLE_ERROR_ADDRESS 16 An invalid pointer was used.
OLE_ERROR_NOT_EQUAL 17 The objects are not equal.
OLE_ERROR_HANDLE 18 An invalid handle was encountered.
OLE_ERROR_GENERIC 19 An error of unknown cause occurred.
OLE_ERROR_CLASS 20 An invalid class was specified.
OLE_ERROR_SYNTAX 21 An invalid command syntax was specified.
OLE_ERROR_DATATYPE 22 The data format requested is not supported.
OLE_ERROR_PALETTE 23 An invalid color palette was specified.
OLE_ERROR_NOT_LINK 24 This is not a linked object.
OLE_ERROR_NOT_EMPTY 25 The client application's document contains objects.
OLE_ERROR_SIZE 26 An incorrect buffer size was passed to a function that places string infromation in the calling function's buffer.
OLE_ERROR_DRIVE 27 The document name contains an invalid drive letter.
OLE_ERROR_NETWORK 28 The client application failed to establish a connection with a network share on which the document is located.
Code Value Description

OLE_ERROR_NAME 29 An invalid name (for example, a document name or an object name) was passed to the function.
OLE_ERROR_TEMPLATE 30 The server application failed to load the specified template.
OLE_ERROR_NEW 31 The server application failed to create a new document.
OLE_ERROR_EDIT 32 The server application failed to create an embedded instance for the object.
OLE_ERROR_OPEN 33 The server application failed to open the document; could also indicate an invalid link.
OLE_ERROR_NOT_OPEN 34 The object is not open for editing.
OLE_ERROR_LAUNCH 35 OLECLI.DLL failed to start the server application.
OLE_ERROR_COMM 36 The client application failed to establish communication with the server application.
OLE_ERROR_TERMINATE 37 An error occurred while terminating the server application.
OLE_ERROR_COMMAND 38 An error occurred in executing a DDE Execute command.
OLE_ERROR_SHOW 39 An error occurred in showing the object.
OLE_ERROR_DOVERB 40 An error occurred in executing a verb; this could also indicate an invalid verb.
OLE_ERROR_ADVISE_NATIVE 41 The server application could not provide the native data for the specified item; this is usually because the item was deleted in the client application.
OLE_ERROR_ADVISE_PICT 42 A picture item could be missing or the server application doesn't recognize the presentation format of the object.
OLE_ERROR_ADVISE_RENAME 43 The server application doesn't support renaming of the object.
OLE_ERROR_POKE_NATIVE 44 The OLE DLLs failed to give the native data to the server application.
OLE_ERROR_REQUEST_NATIVE 45 The server application failed to render the native data.
OLE_ERROR_REQUEST_PICT 46 The server application failed to render the presentation data.
OLE_ERROR_SERVER_BLOCKED 47 The client application is trying to block a server application that is already blocked, or the client is trying to revoke a blocked server or document.
Code Value Description

OLE_ERROR_REGISTRATION 48 The server application is not registered in the system registration database.
OLE_ERROR_ALREADY_REGISTERED 49 The server application is trying to register the same document multiple times.
OLE_ERROR_TASK 50 Either the server or client application is trying to perform an invalid task.
OLE_ERROR_OUTOFDATE 51 The object is out of date.
OLE_ERROR_CANT_UPDATE_CLIENT 52 The client application containing the embedded object doesn't accept updates.
OLE_ERROR_UPDATE 53 An erorr occurred while trying to update the object in the client application.
OLE_ERROR_SETDATA_FORMAT 54 The server application doesn't understand the format given to its SetData method.
OLE_ERROR_STATIC_FROM_OTHER_OS 55 The client application is trying to load a static object created in another operating system.

Note The following message is a warning, not an error.

Code Value Description

OLE_WARN_DELETE_DATA 1000 The calling application must delete the data when it is done with it.