IAPI::ServerDocPostSQLQuery

property ServerDocPostSQLQuery.

Allows app or script to post a SQL query ( aka SELECT ) to ServerDoc.

 

HRESULT ServerDocPostSQLQuery(
  BSTR SQLQuery,
  BSTR SQLiteFile,
  long *pVal
);

Parameters

SQLQuery

[in] .   SQL query statement

SQLiteFile

[in] .   Target SQLite fullpath filename or alias name related with the query

 

         Since version 2.38.0:

         Passing SQLiteFile = “:inbound:” returns the number of incoming messages (received but not dispatched yet).

         Passing SQLiteFile = “:outbound:” returns the number of ongoing messages (queued but not sent yet). 

App or script should use these values in order to reduce and regulate memory/network overloading,
while exchanging messages between client(s) and ServerDoc instance(s).

pVal

[out, retval] The returned value is 0 if succeeded or other value if failed

Return Values

S_OK

The operation was successfull.

E_POINTER

A NULL pointer was supplied as an argument.

E_UNEXPECTED

An unexpected error occoured.

See Also

IAPI