.TH "C interface to DCOP" kde3 "11 Jun 2005" "Version Version 3.4.1" "dcop Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
C interface to DCOP \- 
.SS "Functions"

.in +1c
.ti -1c
.RI "Bool \fBDCOPClient::dcop_attach\fP (void)"
.br
.ti -1c
.RI "char * \fBDCOPClient::dcop_register\fP (const char *app_name, Bool add_pid)"
.br
.ti -1c
.RI "Bool \fBDCOPClient::dcop_detach\fP (void)"
.br
.ti -1c
.RI "Bool \fBDCOPClient::dcop_register_callback\fP (const char *object_id, dcop_callback_t callback)"
.br
.ti -1c
.RI "Bool \fBDCOPClient::dcop_send_signal\fP (const char *receiving_app, const char *object, const char *function, char *data, int data_length)"
.br
.ti -1c
.RI "Bool \fBDCOPClient::dcop_call\fP (const char *app_name, const char *remote_app_name, const char *remote_object_id, const char *remote_function, const char *data, int data_length, char **reply_type, char **reply_data, int *reply_data_length)"
.br
.in -1c
.SH "Detailed Description"
.PP 
dcop_attach, dcop_register, dcop_detach, dcop_register_callback, dcop_send_signal, and dcop_call make up the C interface to DCOP. 
.SH "Function Documentation"
.PP 
.SS "Bool dcop_attach (void)\fC [related, inherited]\fP"
.PP
Attach to the DCOP server. 
.PP
This registers you as anonymous-pid - you may then register with a 'real' name with \fBdcop_register()\fP. 
.SS "char * dcop_register (const char * app_name, Bool add_pid)\fC [related, inherited]\fP"
.PP
Register as app 'app_name'. 
.PP
If add_pid is true, you will be registered as app_name-pid.
.PP
It might not be possible to give you the exact name you requested. In this case, the retval will be different to what you expect, so you should not rely on getting 'app_name'.
.PP
If it was not possible to register, retval is 0. 
.PP
\fBParameters:\fP
.RS 4
\fIapp_name\fP the name of the application. 
.br
\fIadd_pid\fP the process id of the application 
.RE
.PP
\fBReturns:\fP
.RS 4
the registered name, or 0 when the registration failed 
.RE
.PP

.SS "Bool dcop_detach (void)\fC [related, inherited]\fP"
.PP
Detach from the DCOP server. 
.PP
\fBReturns:\fP
.RS 4
true if successful, false otherwise 
.RE
.PP

.SS "Bool dcop_register_callback (const char * object_id, dcop_callback_t callback)\fC [related, inherited]\fP"
.PP
Register the callback function for an object id. 
.PP
This function should have signature dcop_callback_t. The name of the actual function that should be called is passed in the struct. 
.PP
\fBParameters:\fP
.RS 4
\fIobject_id\fP the object id to register 
.br
\fIcallback\fP the callback for the object id 
.RE
.PP
\fBReturns:\fP
.RS 4
true if successful, false otherwise 
.RE
.PP

.SS "Bool dcop_send_signal (const char * receiving_app, const char * object, const char * function, char * data, int data_length)\fC [related, inherited]\fP"
.PP
Send a signal to a DCOP object. 
.PP
\fBParameters:\fP
.RS 4
\fIreceiving_app\fP Name the target application is registered under. Note that you may use wildcards here. For example, you could send to all 'konsole' objects that are registered using the '-pid' extension with 'konsole-*'.
.br
\fIobject\fP Name of the remote object. 
.br
\fIfunction\fP Name of the function to call. 
.br
\fIdata\fP Marshalled arguments to pass to function. 
.br
\fIdata_length\fP Number of octets in data. 
.RE
.PP
\fBReturns:\fP
.RS 4
true if successful, false otherwise 
.RE
.PP

.SS "Bool dcop_call (const char * app_name, const char * remote_app_name, const char * remote_object_id, const char * remote_function, const char * data, int data_length, char ** reply_type, char ** reply_data, int * reply_data_length)\fC [related, inherited]\fP"
.PP
Call a function of a DCOP object. 
.PP
\fBParameters:\fP
.RS 4
\fIapp_name\fP Name this application is registered under. 
.br
\fIremote_app_name\fP Name the target application is registered under. 
.br
\fIremote_object_id\fP Name of the remote object. 
.br
\fIremote_function\fP Name of the function to call. 
.br
\fIdata\fP Marshalled arguments to pass to function. 
.br
\fIdata_length\fP Number of octets in data. 
.br
\fIreply_type\fP Will be set to type of retval, represented as a string. 
.br
\fIreply_data\fP Will be set to retval (marshalled). 
.br
\fIreply_data_length\fP Will be set to number of octets in retval. 
.RE
.PP
\fBReturns:\fP
.RS 4
true if successful, false otherwise 
.RE
.PP

