diff options
author | Matt Dew <marcoz@osource.org> | 2011-05-25 22:54:51 -0600 |
---|---|---|
committer | Matt Dew <marcoz@osource.org> | 2011-06-04 09:32:38 -0600 |
commit | 72d668dd2ec4db9b75973ba24f42ab49851dbc6d (patch) | |
tree | 9e0c3796495041295f6ded8ee5c4c1da2137240e /doc | |
parent | dd7f2beaa753541aefba499813f25de38cbd17b7 (diff) |
add id attributes to funcsynopsis to allow other docs to olink to them
Signed-off-by: Matt Dew <marcoz@osource.org>
Reviewed-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Reviewed-by: Gaetan Nadon <memsize@videotron.ca>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/ICElib.xml | 154 |
1 files changed, 77 insertions, 77 deletions
diff --git a/doc/ICElib.xml b/doc/ICElib.xml index 49f6781..77a8965 100644 --- a/doc/ICElib.xml +++ b/doc/ICElib.xml @@ -203,7 +203,7 @@ function should be called for the client that initiates a <function>ProtocolSetup</function> </para> -<funcsynopsis> +<funcsynopsis id='iceregisterforprotocolsetup'> <funcprototype> <funcdef>int <function>IceRegisterForProtocolSetup</function></funcdef> <paramdef>char<parameter> *protocol_name</parameter></paramdef> @@ -348,7 +348,7 @@ with a <function>ProtocolReply</function></para> -<funcsynopsis> +<funcsynopsis id='iceregisterforprotocolreply'> <funcprototype> <funcdef>Bool <function>IceRegisterForProtocolReply</function></funcdef> <paramdef>char<parameter> *host_name</parameter></paramdef> @@ -548,7 +548,7 @@ library intends to generate a message immediately following the You should pass NULL for protocol_activate_proc if not interested in this callback.</para> -<funcsynopsis> +<funcsynopsis id='protocolsetupproc'> <funcprototype> <funcdef>Status <function>ProtocolSetupProc</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -626,7 +626,7 @@ The ICE library will be responsible for freeing this memory.</para> <function>IceProtocolActivateProc</function> callback is defined as follows:</para> -<funcsynopsis> +<funcsynopsis id='protocolactivateproc'> <funcprototype> <funcdef>void <function>ProtocolActivateProc</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -684,7 +684,7 @@ the <function>IcePoProcessMsgProc</function> callback is invoked.</para> -<funcsynopsis> +<funcsynopsis id='poprocessmsgproc'> <funcprototype> <funcdef>void <function>PoProcessMsgProc</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -750,7 +750,7 @@ the callback is invoked.</para> -<funcsynopsis> +<funcsynopsis id='icepaprocessmsgproc'> <funcprototype> <funcdef>void <function>IcePaProcessMsgProc</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -924,7 +924,7 @@ to the initial "Authentication Required" message or subsequent "Authentication Next Phase" messages sent by the other client.</para> -<funcsynopsis> +<funcsynopsis id='icepoauthstatus '> <funcprototype> <funcdef>IcePoAuthStatus <function>IcePoAuthStatus </function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -1051,7 +1051,7 @@ should return one of four values:</para> is the callback invoked for the client that received the <function>ProtocolSetup</function></para> -<funcsynopsis> +<funcsynopsis id='poauthstatus'> <funcprototype> <funcdef>IcePoAuthStatus <function>PoAuthStatus </function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -1195,7 +1195,7 @@ To open an ICE connection with another client (that is, waiting for connections), use <function>IceOpenConnection</function> </para> -<funcsynopsis> +<funcsynopsis id='iceopenconnection'> <funcprototype> <funcdef>IceConn <function>IceOpenConnection</function></funcdef> <paramdef>char<parameter> *network_ids_list</parameter></paramdef> @@ -1363,7 +1363,7 @@ on pre-arranged transport object names. Such a client may use <function>IceListenForWellKnownConnections</function> to specify the names for the listen objects.</para> -<funcsynopsis> +<funcsynopsis id='icelistenforconnections'> <funcprototype> <funcdef>Status <function>IceListenForConnections</function></funcdef> <paramdef>int<parameter> *count_ret</parameter></paramdef> @@ -1403,7 +1403,7 @@ No more than error_length bytes are used.</para> <function>IceListenForConnections</function> is zero for failure and a positive value for success.</para> -<funcsynopsis> +<funcsynopsis id='icelistenforwellknownconnections'> <funcprototype> <funcdef>Status <function>IceListenForWellKnownConnections</function></funcdef> <paramdef>char<parameter> *port_id</parameter></paramdef> @@ -1487,7 +1487,7 @@ To close and free the listen objects, use <function>IceFreeListenObjs</function> </para> -<funcsynopsis> +<funcsynopsis id='icefreelistenobjs'> <funcprototype> <funcdef>void <function>IceFreeListenObjs</function></funcdef> <paramdef>int<parameter> count</parameter></paramdef> @@ -1522,7 +1522,7 @@ To obtain the descriptor, use <function>IceGetListenConnectionNumber</function> </para> -<funcsynopsis> +<funcsynopsis id='icegetlistenconnectionnumber'> <funcprototype> <funcdef>int <function>IceGetListenConnectionNumber</function></funcdef> <paramdef>IceListenObj<parameter> *listen_objs</parameter></paramdef> @@ -1544,7 +1544,7 @@ To obtain the network ID string associated with a listen object, use </para> -<funcsynopsis> +<funcsynopsis id='icegetlistenconnectionstring'> <funcprototype> <funcdef>char <function>IceGetListenConnectionString</function></funcdef> <paramdef>IceListenObj<parameter> listen_obj</parameter></paramdef> @@ -1593,7 +1593,7 @@ To compose a string containing a list of network IDs separated by commas use <function>IceComposeNetworkIdList</function> </para> -<funcsynopsis> +<funcsynopsis id='icecomposenetworkidlist'> <funcprototype> <funcdef>char <function>IceComposeNetworkIdList</function></funcdef> <paramdef>int<parameter> count</parameter></paramdef> @@ -1631,7 +1631,7 @@ callback associated with it, and this callback is set using the function. </para> -<funcsynopsis> +<funcsynopsis id='icesethostbasedauthproc'> <funcprototype> <funcdef>void <function>IceSetHostBasedAuthProc</function></funcdef> <paramdef>IceListenObj<parameter> listen_obj</parameter></paramdef> @@ -1662,7 +1662,7 @@ host based authentication if it was previously set. </para> -<funcsynopsis> +<funcsynopsis id='hostbasedauthproc'> <funcprototype> <funcdef>Bool <function>HostBasedAuthProc</function></funcdef> <paramdef>char<parameter> *host_name</parameter></paramdef> @@ -1720,7 +1720,7 @@ you should call <function>IceAcceptConnection</function> This returns a new opaque ICE connection object. </para> -<funcsynopsis> +<funcsynopsis id='iceacceptconnection'> <funcprototype> <funcdef>IceConn <function>IceAcceptConnection</function></funcdef> <paramdef>IceListenObj<parameter> listen_obj</parameter></paramdef> @@ -1855,7 +1855,7 @@ or use <function>IceCloseConnection</function></para> -<funcsynopsis> +<funcsynopsis id='icecloseconnection'> <funcprototype> <funcdef>IceCloseStatus <function>IceCloseConnection</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -1950,7 +1950,7 @@ function should be called to turn off shutdown negotiation. This will prevent <function>IceCloseConnection</function> from writing to a broken connection.</para> -<funcsynopsis> +<funcsynopsis id='icesetshutdownnegotiation'> <funcprototype> <funcdef>void <function>IceSetShutdownNegotiation</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -1978,7 +1978,7 @@ shutdown negotiating will be turned off.</para> <para>To check the shutdown negotiation status of an ICE connection, use <function>IceCheckShutdownNegotiation</function></para> -<funcsynopsis> +<funcsynopsis id='icecheckshutdownnegotiation'> <funcprototype> <funcdef>Bool <function>IceCheckShutdownNegotiation</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -2020,7 +2020,7 @@ or closes a connection via use <function>IceAddConnectionWatch</function></para> -<funcsynopsis> +<funcsynopsis id='iceaddconnectionwatch'> <funcprototype> <funcdef>Status <function>IceAddConnectionWatch</function></funcdef> <paramdef>IceWatchProc<parameter> watch_proc</parameter></paramdef> @@ -2085,7 +2085,7 @@ set to <function>True</function> The watch procedure is of type <function>IceWatchProc</function> </para> -<funcsynopsis> +<funcsynopsis id='watchproc'> <funcprototype> <funcdef>void <function>WatchProc</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -2144,7 +2144,7 @@ To remove a watch procedure, use <function>IceRemoveConnectionWatch</function> </para> -<funcsynopsis> +<funcsynopsis id='iceremoveconnectionwatch'> <funcprototype> <funcdef>void <function>IceRemoveConnectionWatch</function></funcdef> <paramdef>IceWatchProc<parameter> watch_proc</parameter></paramdef> @@ -2184,7 +2184,7 @@ To activate a protocol on a given ICE connection, use <function>IceProtocolSetup</function> </para> -<funcsynopsis> +<funcsynopsis id='iceprotocolsetup'> <funcprototype> <funcdef>IceProtocolSetupStatus <function>IceProtocolSetup</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -2317,7 +2317,7 @@ To notify the ICE library when a given protocol will no longer be used on an ICE connection, use <function>IceProtocolShutdown</function> </para> -<funcsynopsis> +<funcsynopsis id='iceprotocolshutdown'> <funcprototype> <funcdef>Status <function>IceProtocolShutdown</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -2362,7 +2362,7 @@ protocol shutdown. <para>To process incoming messages on an ICE connection, use <function>IceProcessMessages</function></para> -<funcsynopsis> +<funcsynopsis id='iceprocessmessages'> <funcprototype> <funcdef>IceProcessMessagesStatus <function>IceProcessMessages</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -2501,7 +2501,7 @@ To send a "Ping" message to the client on the other side of the ICE connection, use <function>IcePing</function> </para> -<funcsynopsis> +<funcsynopsis id='iceping'> <funcprototype> <funcdef>Status <function>IcePing</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -2544,7 +2544,7 @@ processes the Ping reply, it will invoke the <function>IcePingReplyProc</function> callback.</para> -<funcsynopsis> +<funcsynopsis id='pingreplyproc'> <funcprototype> <funcdef>void <function>PingReplyProc</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -2573,7 +2573,7 @@ callback.</para> <chapter id='using_icelib_informational_functions'> <title>Using ICElib Informational Functions</title> -<funcsynopsis> +<funcsynopsis id='iceconnectionstatus'> <funcprototype> <funcdef>IceConnectStatus <function>IceConnectionStatus</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -2608,7 +2608,7 @@ This is only relevant to connections created by </listitem> </itemizedlist> -<funcsynopsis> +<funcsynopsis id='icevendor'> <funcprototype> <funcdef>char <function> *IceVendor</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -2622,7 +2622,7 @@ The string should be freed with a call to <function>free</function> when no longer needed.</para> -<funcsynopsis> +<funcsynopsis id='icerelease'> <funcprototype> <funcdef>char <function> *IceRelease</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -2636,7 +2636,7 @@ The string should be freed with a call to <function>free</function> when no longer needed.</para> -<funcsynopsis> +<funcsynopsis id='iceprotocolversion'> <funcprototype> <funcdef>int <function> IceProtocolVersion</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -2646,7 +2646,7 @@ when no longer needed.</para> <para><function>IceProtocolVersion</function> returns the major version of the ICE protocol on this connection.</para> -<funcsynopsis> +<funcsynopsis id='iceprotocolrevision'> <funcprototype> <funcdef>int <function> IceProtocolRevision</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -2668,7 +2668,7 @@ returns the minor version of the ICE protocol on this connection.</para> <para><function>IceConnectionNumber</function> returns the file descriptor of this ICE connection.</para> -<funcsynopsis> +<funcsynopsis id='iceconnectionstring'> <funcprototype> <funcdef>char <function> *IceConnectionString</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -2681,7 +2681,7 @@ accepted this connection. The string should be freed with a call to <function>free</function> when no longer needed.</para> -<funcsynopsis> +<funcsynopsis id='icelastsentsequencenumber'> <funcprototype> <funcdef>unsigned long <function> IceLastSentSequenceNumber</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -2703,7 +2703,7 @@ returns the sequence number of the last message sent on this ICE connection.</pa returns the sequence number of the last message received on this ICE connection.</para> -<funcsynopsis> +<funcsynopsis id='iceswapping'> <funcprototype> <funcdef>Bool <function> IceSwapping</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -2716,7 +2716,7 @@ returns <function>True</function> if byte swapping is necessary when reading messages on the ICE connection.</para> -<funcsynopsis> +<funcsynopsis id='icegetcontext'> <funcprototype> <funcdef>IcePointer <function> IceGetContext</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -2771,7 +2771,7 @@ To get the size of the ICE output buffer, use <function>IceGetOutBufSize</function> </para> -<funcsynopsis> +<funcsynopsis id='icegetoutbufsize'> <funcprototype> <funcdef>int <function> IceGetOutBufSize</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -2792,7 +2792,7 @@ To get the size of the ICE output buffer, use To flush the ICE output buffer, use <function>IceFlush</function> </para> -<funcsynopsis> +<funcsynopsis id='iceflush'> <funcprototype> <funcdef>int <function> IceFlush</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -2815,7 +2815,7 @@ insufficient space to generate a message. <para>The following macros can be used to generate ICE messages:</para> -<funcsynopsis> +<funcsynopsis id='icegetheader'> <funcprototype> <funcdef><function> IceGetHeader</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -2879,7 +2879,7 @@ updated. </para> -<funcsynopsis> +<funcsynopsis id='icegetheaderextra'> <funcprototype> <funcdef><function> IceGetHeaderExtra</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -2961,7 +2961,7 @@ of variable length data. The complete message must fit in the ICE output buffer. </para> -<funcsynopsis> +<funcsynopsis id='icesimplemessage'> <funcprototype> <funcdef><function> IceSimpleMessage</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -2997,7 +2997,7 @@ is used to generate a message that is identical in size to the ICE header message, and has no additional data. </para> -<funcsynopsis> +<funcsynopsis id='iceerrorheader'> <funcprototype> <funcdef><function> IceErrorHeader</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -3124,7 +3124,7 @@ This macro is used in conjunction with <function>IceErrorHeader</function> </para> -<funcsynopsis> +<funcsynopsis id='icewritedata'> <funcprototype> <funcdef><function> IceWriteData</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -3159,7 +3159,7 @@ This macro is used in conjunction with To write data as 16-bit quantities, use <function>IceWriteData16</function> </para> -<funcsynopsis> +<funcsynopsis id='icewritedata16'> <funcprototype> <funcdef><function> IceWriteData16</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -3194,7 +3194,7 @@ To write data as 32-bit quantities, use <function>IceWriteData32</function> </para> -<funcsynopsis> +<funcsynopsis id='icewritedata32'> <funcprototype> <funcdef><function> IceWriteData32</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -3234,7 +3234,7 @@ To bypass copying data to the ICE output buffer, use connection. If necessary, the ICE output buffer is first flushed. </para> -<funcsynopsis> +<funcsynopsis id='icesenddata'> <funcprototype> <funcdef><function> IceSendData</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -3270,7 +3270,7 @@ To force 32-bit or 64-bit alignment, use <function>IceWritePad</function> A maximum of 7 pad bytes can be specified. </para> -<funcsynopsis> +<funcsynopsis id='icewritepad'> <funcprototype> <funcdef><function> IceWritePad</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -3322,7 +3322,7 @@ To get the size of the ICE input buffer, use <function>IceGetInBufSize</function> </para> -<funcsynopsis> +<funcsynopsis id='icegetinbufsize'> <funcprototype> <funcdef>int<function> IceGetInBufSize</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -3351,7 +3351,7 @@ read operations will be ignored. For further information, see </para> -<funcsynopsis> +<funcsynopsis id='icevalidio'> <funcprototype> <funcdef>Bool<function> IceValidIO</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -3369,7 +3369,7 @@ read operations will be ignored. For further information, see <para>The following macros can be used to read ICE messages.</para> -<funcsynopsis> +<funcsynopsis id='icereadsimplemessage'> <funcprototype> <funcdef><function> IceReadSimpleMessage</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -3420,7 +3420,7 @@ the variable length data in chunks (see </para> -<funcsynopsis> +<funcsynopsis id='icereadcompletemessage'> <funcprototype> <funcdef><function> IceReadCompleteMessage</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -3482,7 +3482,7 @@ should be called. </para> -<funcsynopsis> +<funcsynopsis id='icedisposecompletemessage'> <funcprototype> <funcdef><function> IceDisposeCompleteMessage</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -3514,7 +3514,7 @@ it did not fit in the ICE input buffer), it is freed here by ICElib. </para> -<funcsynopsis> +<funcsynopsis id='icereadmessageheader'> <funcprototype> <funcdef><function> IceReadMessageHeader</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -3564,7 +3564,7 @@ To read data directly into a user supplied buffer, use <function>IceReadData</function> </para> -<funcsynopsis> +<funcsynopsis id='icereaddata'> <funcprototype> <funcdef><function> IceReadData</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -3599,7 +3599,7 @@ To read data directly into a user supplied buffer, use To read data as 16-bit quantities, use <function>IceReadData16</function> </para> -<funcsynopsis> +<funcsynopsis id='icereaddata16'> <funcprototype> <funcdef><function> IceReadData16</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -3643,7 +3643,7 @@ If <function>True,</function> the values will be byte swapped. To read data as 32-bit quantities, use <function>IceReadData32</function> </para> -<funcsynopsis> +<funcsynopsis id='icereaddata32'> <funcprototype> <funcdef><function> IceReadData32</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -3686,7 +3686,7 @@ If <function>True,</function> the values will be byte swapped. <function>IceReadPad</function> A maximum of 7 pad bytes can be specified.</para> -<funcsynopsis> +<funcsynopsis id='icereadpad'> <funcprototype> <funcdef><function> IceReadPad</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -3740,7 +3740,7 @@ prefer your own error handling and can be changed as often as you like. To set the ICE error handler, use <function>IceSetErrorHandler</function> </para> -<funcsynopsis> +<funcsynopsis id='iceseterrorhandler'> <funcprototype> <funcdef><function> IceSetErrorHandler</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -3784,7 +3784,7 @@ should have their own error handlers). An ICE error handler has the type of <function>IceErrorHandler</function> </para> -<funcsynopsis> +<funcsynopsis id='iceerrorhandler'> <funcprototype> <funcdef>void<function> IceErrorHandler</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -3879,7 +3879,7 @@ To handle fatal I/O errors, use <function>IceSetIOErrorHandler</function> </para> -<funcsynopsis> +<funcsynopsis id='icesetioerrorhandler'> <funcprototype> <funcdef>IceIOErrorHandler<function> IceSetIOErrorHandler</function></funcdef> <paramdef>IceIOErrorHandler<parameter> handler</parameter></paramdef> @@ -3907,7 +3907,7 @@ An ICE I/O error handler has the type of <function>IceIOErrorHandler</function> </para> -<funcsynopsis> +<funcsynopsis id='iceioerrorhandler'> <funcprototype> <funcdef>void<function> IceIOErrorHandler</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -3965,7 +3965,7 @@ and could be used to clean up state specific to the protocol. </para> -<funcsynopsis> +<funcsynopsis id='iceioerrorproc'> <funcprototype> <funcdef>void<function> IceIOErrorProc</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -4017,14 +4017,14 @@ sections of code that access an ICE connection (for example, when generating messages). Two calls, which are generally implemented as macros, are provided:</para> -<funcsynopsis> +<funcsynopsis id='icelockconn'> <funcprototype> <funcdef>void<function> IceLockConn</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> </funcprototype> </funcsynopsis> -<funcsynopsis> +<funcsynopsis id='iceunlockconn'> <funcprototype> <funcdef>void<function> IceUnlockConn</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -4043,7 +4043,7 @@ macros, are provided:</para> and <function>IceAppUnlockConn</function></para> -<funcsynopsis> +<funcsynopsis id='iceapplockconn'> <funcprototype> <funcdef>void<function> IceAppLockConn</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -4070,7 +4070,7 @@ If the program has not previously called <function>IceAppLockConn</function> has no effect.</para> -<funcsynopsis> +<funcsynopsis id='iceappunlockconn'> <funcprototype> <funcdef>void<function> IceAppUnlockConn</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -4110,7 +4110,7 @@ The contents of the scratch space is not guaranteed to be preserved after any ICElib function is called.</para> -<funcsynopsis> +<funcsynopsis id='iceallocscratch'> <funcprototype> <funcdef>char<function> *IceAllocScratch</function></funcdef> <paramdef>IceConn<parameter> ice_conn</parameter></paramdef> @@ -4290,7 +4290,7 @@ This function takes advantage of the fact that the system call will fail if the name of the new link already exists. </para> -<funcsynopsis> +<funcsynopsis id='icelockauthfile'> <funcprototype> <funcdef>int<function> IceLockAuthFile</function></funcdef> <paramdef>char<parameter> *file_name</parameter></paramdef> @@ -4355,7 +4355,7 @@ retries failed. To unlock an authorization file, use <function>IceUnlockAuthFile</function> </para> -<funcsynopsis> +<funcsynopsis id='iceunlockauthfile'> <funcprototype> <funcdef>int<function> IceUnlockAuthFile</function></funcdef> <paramdef>char<parameter> *file_name</parameter></paramdef> @@ -4374,7 +4374,7 @@ To read the next entry in an authorization file, use <function>IceReadAuthFileEntry</function> </para> -<funcsynopsis> +<funcsynopsis id='icereadauthfileentry'> <funcprototype> <funcdef>IceAuthFileEntry<function> *IceReadAuthFileEntry</function></funcdef> <paramdef>FILE<parameter> *auth_file</parameter></paramdef> @@ -4404,7 +4404,7 @@ To write an entry in an authorization file, use <function>IceWriteAuthFileEntry</function> </para> -<funcsynopsis> +<funcsynopsis id='icewriteauthfileentry'> <funcprototype> <funcdef>Status<function> IceWriteAuthFileEntry</function></funcdef> <paramdef>FILE<parameter> *auth_file</parameter></paramdef> @@ -4436,7 +4436,7 @@ protocol_name/network_id/auth_name tuple, use <function>IceGetAuthFileEntry</function> </para> -<funcsynopsis> +<funcsynopsis id='icegetauthfileentry'> <funcprototype> <funcdef>IceAuthFileEntry<function> *IceGetAuthFileEntry</function></funcdef> <paramdef>char<parameter> *protocol_name</parameter></paramdef> @@ -4477,7 +4477,7 @@ To free an entry returned by <function>IceFreeAuthFileEntry</function> </para> -<funcsynopsis> +<funcsynopsis id='icefreeauthfileentry'> <funcprototype> <funcdef>void<function> IceFreeAuthFileEntry</function></funcdef> <paramdef>IceAuthFileEntry<parameter> *entry</parameter></paramdef> @@ -4517,7 +4517,7 @@ for the MIT-MAGIC-COOKIE-1 authentication procedure to accept or reject the connection, it will compare the magic cookie presented by the requestor to the magic cookie in memory.</para> -<funcsynopsis> +<funcsynopsis id='icegeneratemagiccookie'> <funcprototype> <funcdef>char<function> *IceGenerateMagicCookie</function></funcdef> <paramdef>int<parameter> length</parameter></paramdef> @@ -4544,7 +4544,7 @@ Currently, this function is only used for MIT-MAGIC-COOKIE-1 authentication, but it may be used for additional authentication methods in the future.</para> -<funcsynopsis> +<funcsynopsis id='icesetpaauthdata'> <funcprototype> <funcdef>void<function> IceSetPaAuthData</function></funcdef> <paramdef>int<parameter> num_entries</parameter></paramdef> |