isc_service_start()
Go Up to API Function Reference
Performs a service task on the InterBase server to which the client is attached.
Syntax
ISC_STATUS isc_service_start(
ISC_STATUS *status_vector,
isc_svc_handle *svc_handle,
isc_resv_handle *reserved,
unsigned short spb_length,
char *spb);
| Parameter | Type | Description |
|---|---|---|
|
<status_vector> |
|
Pointer to the error status vector. |
|
<svc_handle> |
|
Pointer to a long value containing the handle of the service structure. |
|
<reserved> |
|
Reserved for future use; should be NULL. |
|
<spb_length> |
unsigned short |
Length in bytes of the service parameter buffer. |
|
<spb> |
char * |
Pointer to a service parameter buffer containing flags and optional arguments instructing the Services Manager to perform specified tasks. |
Description
Use isc_service_start() to initiate a task execution by the Services Manager. You must have an active connection to a running Services Manager, made using isc_service_attach().
There are components in the InterBase Express™ package for Delphi and C++Builder that provide a visual interface to the Services Manager. See the Developer's Guide for more information.
Example
There are several examples of using isc_service_start() with C/C++ in Invoking Service Tasks with isc_service_start( ).
Return value
isc_service_start() returns the second element of the status vector. Zero indicates success. A nonzero value indicates an error. For InterBase errors, the first element of the status vector is set to 1, and the second element is set to an InterBase error code.
To check for an InterBase error, examine the first two elements of the status vector directly. For more information about examining the status vector, see Handling Error Conditions.