From f7473da7b1ff6a5295a145f808c327e655e574a9 Mon Sep 17 00:00:00 2001 From: Matt Dew Date: Wed, 25 May 2011 23:46:36 -0600 Subject: add id attributes to funcsynopsis to allow other docs to olink to them. Signed-off-by: Matt Dew Reviewed-by: Alan Coopersmith Reviewed-by: Gaetan Nadon --- doc/SMlib.xml | 116 +++++++++++++++++++++++++++++----------------------------- 1 file changed, 58 insertions(+), 58 deletions(-) diff --git a/doc/SMlib.xml b/doc/SMlib.xml index 130bfa7..11ae60f 100644 --- a/doc/SMlib.xml +++ b/doc/SMlib.xml @@ -265,7 +265,7 @@ To open a connection with a session manager, use SmcOpenConnection - + SmcConn SmcOpenConnection char *network_ids_list @@ -492,7 +492,7 @@ typedef struct { The Save Yourself callback is of type SmcSaveYourselfProc - + typedef void (*SaveYourselfProc) SmcConn smc_conn @@ -627,7 +627,7 @@ set fast to True. The Die callback is of type SmcDieProc - + typedef void (*SmcDieProc) SmcConn smc_conn @@ -663,7 +663,7 @@ before the “Die” message. The Save Complete callback is of type SmcSaveCompleteProc - + typedef void (*SmcSaveCompleteProc) SmcConn smc_conn @@ -692,7 +692,7 @@ The Shutdown Cancelled callback is of type SmcShutdownCancelledProc - + typedef void (*SmcShutdownCancelledProc) SmcConn smc_conn @@ -734,7 +734,7 @@ To close a connection with a session manager, use SmcCloseConnection - + SmcCloseStatus SmcCloseConnection SmcConn smc_conn @@ -816,7 +816,7 @@ To modify callbacks set up in SmcOpenConnection use SmcModifyCallbacks - + void SmcModifyCallbacks SmcConn smc_conn @@ -860,7 +860,7 @@ To set session management properties for this client, use SmcSetProperties - + void SmcSetProperties SmcConn smc_conn @@ -907,7 +907,7 @@ To delete properties previously set by the client, use SmcDeleteProperties - + void SmcDeleteProperties SmcConn smc_conn @@ -935,7 +935,7 @@ To get properties previously stored by the client, use SmcGetProperties - + Status SmcGetProperties SmcConn smc_conn @@ -970,7 +970,7 @@ back. Rather, a callback of type SmcPropReplyProc is invoked when the data is ready. - + typedef void (*SmcPropReplyProc) SmcConn smc_conn @@ -1020,7 +1020,7 @@ user at a time, the client must call SmcInteractRequest and wait for an “Interact” message from the session manager. - + Status SmcInteractRequest SmcConn smc_conn @@ -1078,7 +1078,7 @@ The SmcInteractProc callback will be invoked when the “Interact” message arrives from the session manager. - + typedef void (*SmcInteractProc) SmcConn smc_conn @@ -1102,7 +1102,7 @@ After interacting with the user (in response to an “Interact” message), you should call SmcInteractDone - + void SmcInteractDone SmcConn smc_conn @@ -1138,7 +1138,7 @@ To request a checkpoint from the session manager, use SmcRequestSaveYourself - + void SmcRequestSaveYourself SmcConn smc_conn @@ -1210,7 +1210,7 @@ informed when all the other clients are quiescent so that it can save their state. To do so, use SmcRequestSaveYourselfPhase2 - + Status SmcRequestSaveYourselfPhase2 SmcConn smc_conn @@ -1255,7 +1255,7 @@ After saving state in response to a “Save Yourself” message, you should call SmcSaveYourselfDone - + void SmcSaveYourselfDone SmcConn smc_conn @@ -1284,7 +1284,7 @@ registered with the session manager. Using Smc Informational Functions - + int SmcProtocolVersion SmcConn smc_conn @@ -1297,7 +1297,7 @@ the session management protocol associated with this session. - + int SmcProtocolRevision SmcConn smc_conn @@ -1309,7 +1309,7 @@ the session management protocol associated with this session. the session management protocol associated with this session. - + char *SmcVendor SmcConn smc_conn @@ -1322,7 +1322,7 @@ identification of the owner of the session manager. The string should be freed with a call to free - + char *SmcRelease SmcConn smc_conn @@ -1335,7 +1335,7 @@ release number of the session manager. The string should be freed with a call to free - + char *SmcClientID SmcConn smc_conn @@ -1350,7 +1350,7 @@ provided here for convenience). Call free on this pointer when the client ID is no longer needed. - + IceConn SmcGetIceConnection SmcConn smc_conn @@ -1384,7 +1384,7 @@ is fatal. The client can change this error handler by calling the SmcSetErrorHandler function. - + SmcErrorHandler SmcSetErrorHandler SmcErrorHandler handler @@ -1405,7 +1405,7 @@ restore the default handler. The SmcErrorHandler has the following type: - + typedef void (*SmcErrorHandler) SmcConn smc_conn @@ -1495,7 +1495,7 @@ the session manager and registers a callback that will be invoked each time a new client connects to the session manager. - + Status SmsInitialize char *vendor @@ -1571,7 +1571,7 @@ session manager must also register a set of callbacks to respond to the different messages that the client might send. - + typedef Status (*SmsNewClientProc) SmsConn sms_conn @@ -1708,7 +1708,7 @@ invoked after the client connects to the session manager. Its type is SmsRegisterClientProc - + typedef Status (*SmsRegisterClientProc) SmsConn sms_conn @@ -1770,7 +1770,7 @@ The Interact Request callback is of type SmsInteractRequestProc - + typedef void (*SmsInteractRequestProc) SmsConn sms_conn @@ -1831,7 +1831,7 @@ When the client is done interacting with the user, the SmsInteractDoneProc callback will be invoked. - + typedef void (*SmsInteractDoneProc) SmsConn sms_conn @@ -1873,7 +1873,7 @@ The Save Yourself Request callback is of type SmsSaveYourselfRequestProc - + typedef void (*SaveYourselfRequestProc) SmsConn sms_conn @@ -1942,7 +1942,7 @@ The Save Yourself Phase 2 Request callback is of type SmsSaveYourselfPhase2RequestProc - + typedef void (*SmsSaveYourselfPhase2RequestProc) SmsConn sms_conn @@ -1978,7 +1978,7 @@ When the client is done saving its state in response to a the SmsSaveYourselfDoneProc will be invoked. - + typedef void (*SaveYourselfDoneProc) SmsConn sms_conn @@ -2018,7 +2018,7 @@ calls SmcCloseConnection, the SmsCloseConnectionProc callback is invoked. - + typedef void (*SmsCloseConnectionProc) SmsConn sms_conn @@ -2071,7 +2071,7 @@ When the client sets session management properties, the SmsSetPropertiesProc callback will be invoked. - + typedef void (*SmsSetPropertiesProc) SmsConn sms_conn @@ -2130,7 +2130,7 @@ When the client deletes session management properties, the SmsDeletePropertiesProc callback will be invoked. - + typedef void (*SmsDeletePropertiesProc) SmsConn sms_conn @@ -2176,7 +2176,7 @@ The SmsGetPropertiesProc callback is invoked when the client wants to retrieve properties it set. - + typedef void (*SmsGetPropertiesProc) SmsConn sms_conn @@ -2212,7 +2212,7 @@ a SmsRegisterClientProc callback), use SmsRegisterClientReply. - + Status SmsRegisterClientReply SmsConn sms_conn @@ -2271,7 +2271,7 @@ You should call the SmsGenerateClientID function to generate a globally unique client ID. - + char *SmsGenerateClientID SmsConn sms_conn @@ -2302,7 +2302,7 @@ To send a “Save Yourself” to a client, use SmsSaveYourself. - + void SmsSaveYourself SmsConn sms_conn @@ -2405,7 +2405,7 @@ In order to send a “Save Yourself Phase 2” message to a client, use SmsSaveYourselfPhase2 - + void SmsSaveYourselfPhase2 SmsConn sms_conn @@ -2435,7 +2435,7 @@ To send an “Interact” message to a client, use SmsInteract. - + void SmsInteract SmsConn sms_conn @@ -2465,7 +2465,7 @@ To send a “Save Complete” message to a client, use SmsSaveComplete. - + void SmsSaveComplete SmsConn sms_conn @@ -2493,7 +2493,7 @@ To send a “Die” message to a client, use SmsDie. - + void SmsDie SmsConn sms_conn @@ -2521,7 +2521,7 @@ a “Die” message to, timing out appropriately. To cancel a shutdown, use SmsShutdownCancelled. - + void SmsShutdownCancelled SmsConn sms_conn @@ -2555,7 +2555,7 @@ In response to a “Get Properties” message, the session manager should call SmsReturnProperties. - + void SmsReturnProperties SmsConn sms_conn @@ -2601,7 +2601,7 @@ the SmsGetIceConnection - + void IcePing IceConn ice_conn @@ -2633,7 +2633,7 @@ session manager should have some sort of timeout period, after which it assumes the client has unexpectedly died. - + typedef void (*IcePingReplyProc) IceConn ice_conn @@ -2664,7 +2664,7 @@ it should call the SmsCleanUp function in order to free up the connection object. - + void SmsCleanUp SmsConn sms_conn @@ -2683,7 +2683,7 @@ to free up the connection object. Using Sms Informational Functions - + int SmsProtocolVersion SmsConn sms_conn @@ -2695,7 +2695,7 @@ to free up the connection object. the session management protocol associated with this session. - + int SmsProtocolRevision SmsConn sms_conn @@ -2707,7 +2707,7 @@ the session management protocol associated with this session. the session management protocol associated with this session. - + char *SmsClientID SmsConn sms_conn @@ -2728,7 +2728,7 @@ use SmsClientHostName. This host name will be needed to restart the client. - + char *SmsClientHostName SmsConn sms_conn @@ -2744,7 +2744,7 @@ You should call free on the string returned when it is no longer needed. - + IceConn SmsGetIceConnection SmsConn sms_conn @@ -2775,7 +2775,7 @@ session manager can change this error handler by calling SmsSetErrorHandler. - + SmsErrorHandler SmsSetErrorHandler SmsErrorHandler handler @@ -2792,7 +2792,7 @@ to restore the default handler. The SmsErrorHandler has the following type: - + typedef void (*SmsErrorHandler) SmsConn sms_conn @@ -3141,7 +3141,7 @@ contain the user's name (the pw_name member of To free an individual property, use SmFreeProperty - + void SmFreeProperty SmProp *prop @@ -3161,7 +3161,7 @@ the SmsCloseConnectionProc callback, use SmFreeReasons - + void SmFreeReasons int count -- cgit v1.2.1