| Current Path : /var/www/html/mmishra/indem/iiita/Doc/ |
| Current File : /var/www/html/mmishra/indem/iiita/Doc/interface_tread.html |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>VersyPHP Documentation</title>
</head>
<body style="color: rgb(8, 38, 176); font-size: 20px; table-layout: fixed; margin-left: 35px; width: 872px; margin-top: 26px; height: 249px;" text="">
<table style="width: 878px; height: 54px;" align="center" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td align="left" width="30%">
<img src="logo.gif" align="middle" border="0" height="50" width="85">
</td>
<td style="width: 45%;" align="right">
<h1 style="font-size: 10pt;"> VESRYPDF.PHP DOCUMENATION </h1>
</td>
</tr>
</tbody>
</table>
<h2 style="color: rgb(71, 38, 125); font-family: serif; font-size: 12pt;">VersyPDF Thread and Bead manipulation Interface</h2>
<h3 style="color: rgb(71, 38, 125); font-family: serif; font-size: 11pt;">FUNCTIONS:</h3>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfdoc_get_thread_count</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Gets Threads Count in PDF Document.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Doc </b>- [in] PDF Document Handle.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
Number of Threads Items.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
$Count = pdfdoc_get_thread_count( $Doc );
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfdoc_get_thread</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Gets Thread of PDF Document according to Index.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Doc </b>- [in] PDF Document Handle.
<br><b>$Index </b>- [in] Index of Thread in PDF Document.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
Thread Handle.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
$Thread = pdfdoc_get_thread( $Doc, $Index );
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfthread_new</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Creates New Thread in PDF Document.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Doc </b>- [in] PDF Document Handle.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
New Thread Handle in PDF Document.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
$Thread = pdfthread_new( $Doc );
</td>
</tr>
<tr><td width="15%"><b>See Also :</b></td>
<td style="color : brown;">
pdfthread_delete.
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfthread_delete</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Deletes Thread from PDF Document.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Doc </b>- [in] PDF Document Handle.
<br><b>$Thread </b>- [in] Thread Handle in PDF Document for Deleting.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
None.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
pdfthread_delete( $Thread );
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfthread_get_info</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Gets information from Thread according to Name.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Thread </b>- [in] Thread Handle in PDF Document.
<br><b>$InfoType </b>- [in] Name of requesting information.
<br><b>$StrLen </b>- [out] Length of value in bytes ( must be a reference ).
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
String with information data
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
$InfoData = pdfthread_get_info( $Thread, $InfoType, &$StrLen );
</td>
</tr>
<tr><td width="15%"><b>See Also :</b></td>
<td style="color : brown;">
pdfthread_set_info, PDF Document Information Type ( PI_ ) constants.
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfthread_set_info</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Sets information to Thread according to property name.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Thread </b>- [in] Thread Handle in PDF Document.
<br><b>$InfoType </b>- [in] Name of setting information.
<br><b>$Value </b>- [in] Text string information value.
<br><b>$Length </b>- [in] Length of value in bytes.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
None.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
pdfthread_set_info( $Thread, $Info, $Value, $Length );
</td>
</tr>
<tr><td width="15%"><b>See Also :</b></td>
<td style="color : brown;">
pdfthread_get_info, PDF Document Information Type ( PI_ ) constants.
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfthread_get_first_bead</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Gets Bead Handle on First Bead in Thread.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Thread </b>- [in] Thread Handle in PDF Document for founding the first bead.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
Bead Handle on the First Bead in Thread.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
$Bead = pdfthread_get_first_bead( $Thread );
</td>
</tr>
<tr><td width="15%"><b>See Also :</b></td>
<td style="color : brown;">
pdfthread_set_first_bead.
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfthread_append_bead</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Creates new bead on the page for Thread.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Thread </b>- [in] Thread Handle.
<br><b>$Page </b>- [in] Index of Page on which this bead will be appeared.
<br><b>$Rect </b>- [in] A rectangle specifying the location of this bead on the page.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
Bead Handle.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
$Bead = pdfthread_append_bead( $Thread, $Page, $Rect );
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfbead_get_next</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Navigates to the next bead item.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Bead </b>- [in] Bead whence we go onward.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
Handle of next bead.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
$Bead = pdfbead_get_next( $Bead );
</td>
</tr>
<tr><td width="15%"><b>See Also :</b></td>
<td style="color : brown;">
pdfbead_get_prev
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfbead_get_prev</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Navigates to previous bead item.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Bead </b>- [in] Bead whence we go back.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
Handle of previous bead.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
$Bead = pdfbead_get_prev( $Bead );
</td>
</tr>
<tr><td width="15%"><b>See Also :</b></td>
<td style="color : brown;">
pdfbead_get_next.
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfbead_get_rect</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Gets a rectangle specifying the location of this bead on the page.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Bead </b>- [in] Bead Handle.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
None.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
$Rect = pdfbead_get_rect( $Bead );
</td>
</tr>
<tr><td width="15%"><b>See Also :</b></td>
<td style="color : brown;">
pdfbead_set_rect.
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfbead_get_page</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Gets an Index of Page on which this bead appears.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Bead </b>- [in] Bead Handle.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
Index of Page on which this bead appears.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
$Page = pdfbead_get_page( $Bead );
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfbead_get_thread</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Gets a Handle of Bead's Thread.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Bead </b>- [in] Bead Handle.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
Handle of Bead's Thread.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
$Thread = pdfbead_get_thread( $Bead );
</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfbead_set_rect</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>
Sets a rectangle specifying the location of this bead on the page.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Bead </b>- [in] Bead Handle.
<br><b>$Rect </b>- [in] Rectangle specifying the location of this bead on the page.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>
None.
</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">
pdfbead_set_rect( $Bead, $Rect );
</td>
</tr>
<tr><td width="15%"><b>See Also :</b></td>
<td style="color : brown;">
pdfbead_get_rect.
</td>
</tr>
</table><br>
</body></html>