← Back to branch summary

~ubuntu-branches/ubuntu/intrepid/graphicsmagick/intrepid

« back to all changes in this revision

Viewing changes to www/api/resource.html

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Kobras
  • Date: 2006-05-06 16:28:08 UTC
  • Revision ID: james.westby@ubuntu.com-20060506162808-vt2ni3r5nytcszms
Tags: upstream-1.1.7
Import upstream version 1.1.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
www/api/resource.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 
2
<html xmlns="http://www.w3.org/1999/xhtml">
 
3
<head>
 
4
<title>resource - Set resource consumption limits</title>
 
5
<link rev="made" href="mailto:bfriesen@scooby.simplesystems.org" />
 
6
</head>
 
7
 
 
8
<body style="background-color: white">
 
9
 
 
10
<P><a name="__index__"></a></P>
 
11
<!-- INDEX BEGIN -->
 
12
 
 
13
<ul>
 
14
 
 
15
        <li><a href="#name">NAME</a></li>
 
16
        <li><a href="#synopsis">SYNOPSIS</a></li>
 
17
        <li><a href="#function_descriptions">FUNCTION DESCRIPTIONS</a></li>
 
18
        <ul>
 
19
 
 
20
                <li><a href="#acquiremagickresource">AcquireMagickResource</a></li>
 
21
                <li><a href="#getmagickresource">GetMagickResource</a></li>
 
22
                <li><a href="#liberatemagickresource">LiberateMagickResource</a></li>
 
23
                <li><a href="#listmagickresourceinfo">ListMagickResourceInfo</a></li>
 
24
                <li><a href="#setmagickresourcelimit">SetMagickResourceLimit</a></li>
 
25
        </ul>
 
26
 
 
27
</ul>
 
28
<!-- INDEX END -->
 
29
 
 
30
<hr />
 
31
<P>
 
32
</P>
 
33
<h1><a name="name">NAME</a></h1>
 
34
<P>resource - Set resource consumption limits (e.g. memory)</P>
 
35
<P>
 
36
</P>
 
37
<hr />
 
38
<h1><a name="synopsis">SYNOPSIS</a></h1>
 
39
<P>unsigned int  <strong>AcquireMagickResource</strong>( const ResourceType type, const magick_int64_t size );</P>
 
40
<P>unsigned long  <strong>GetMagickResource</strong>( const ResourceType type );</P>
 
41
<P>void  <strong>LiberateMagickResource</strong>( const ResourceType type, const magick_int64_t size );</P>
 
42
<P>unsigned int  <strong>ListMagickResourceInfo</strong>( FILE *file, ExceptionInfo *exception );</P>
 
43
<P>void  <strong>SetMagickResourceLimit</strong>( const ResourceType type, const unsigned long limit );</P>
 
44
<P>
 
45
</P>
 
46
<hr />
 
47
<h1><a name="function_descriptions">FUNCTION DESCRIPTIONS</a></h1>
 
48
<P>
 
49
</P>
 
50
<h2><a name="acquiremagickresource">AcquireMagickResource</a></h2>
 
51
<blockquote>AcquireMagickResource() acquires resources of the specified type. True is returned if the specified resource is available otherwise False. </blockquote><blockquote>The format of the AcquireMagickResource() method is: </blockquote><blockquote>unsigned int AcquireMagickResource ( const <A HREF="types.html#ResourceType">ResourceType</A> type, const magick_int64_t size ); </blockquote><P>A description of each parameter follows:</P>
 
52
<dl>
 
53
<dt><strong><a name="item_o_type_3a">type:</a></strong><br />
 
54
</dt>
 
55
<DD>
 
56
The type of resource.
 
57
</dd>
 
58
<P></P>
 
59
<dt><strong><a name="item_o_size_3a">size:</a></strong><br />
 
60
</dt>
 
61
<DD>
 
62
The number of bytes needed from for this resource.
 
63
</dd>
 
64
<P></P></dl>
 
65
<P>
 
66
</P>
 
67
<h2><a name="getmagickresource">GetMagickResource</a></h2>
 
68
<blockquote>GetMagickResource() returns the the specified resource in megabytes. </blockquote><blockquote>The format of the GetMagickResource() method is: </blockquote><blockquote>unsigned long GetMagickResource ( const <A HREF="types.html#ResourceType">ResourceType</A> type ); </blockquote><P>A description of each parameter follows:</P>
 
69
<dl>
 
70
<dt><strong>type:</strong><br />
 
71
</dt>
 
72
<DD>
 
73
The type of resource.
 
74
</dd>
 
75
<P></P></dl>
 
76
<P>
 
77
</P>
 
78
<h2><a name="liberatemagickresource">LiberateMagickResource</a></h2>
 
79
<blockquote>LiberateMagickResource() liberates resources of the specified type. </blockquote><blockquote>The format of the LiberateMagickResource() method is: </blockquote><blockquote>void LiberateMagickResource ( const <A HREF="types.html#ResourceType">ResourceType</A> type, const magick_int64_t size ); </blockquote><P>A description of each parameter follows:</P>
 
80
<dl>
 
81
<dt><strong>type:</strong><br />
 
82
</dt>
 
83
<DD>
 
84
The type of resource.
 
85
</dd>
 
86
<P></P>
 
87
<dt><strong>size:</strong><br />
 
88
</dt>
 
89
<DD>
 
90
The size of the resource.
 
91
</dd>
 
92
<P></P></dl>
 
93
<P>
 
94
</P>
 
95
<h2><a name="listmagickresourceinfo">ListMagickResourceInfo</a></h2>
 
96
<P>Method ListMagickResourceInfo lists the resource info to a file.</P>
 
97
<P>The format of the ListMagickResourceInfo method is:</P>
 
98
<blockquote>unsigned int ListMagickResourceInfo ( FILE *file, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows.</P>
 
99
<dl>
 
100
<dt><strong><a name="item_o_file_3a">file:</a></strong><br />
 
101
</dt>
 
102
<DD>
 
103
An pointer to a FILE.
 
104
</dd>
 
105
<P></P>
 
106
<dt><strong><a name="item_o_exception_3a">exception:</a></strong><br />
 
107
</dt>
 
108
<DD>
 
109
Return any errors or warnings in this structure.
 
110
</dd>
 
111
<P></P></dl>
 
112
<P>
 
113
</P>
 
114
<h2><a name="setmagickresourcelimit">SetMagickResourceLimit</a></h2>
 
115
<blockquote>SetMagickResourceLimit() sets the limit for a particular resource in megabytes. </blockquote><blockquote>The format of the SetMagickResourceLimit() method is: </blockquote><blockquote>void SetMagickResourceLimit ( const <A HREF="types.html#ResourceType">ResourceType</A> type, const unsigned long limit ); </blockquote><P>A description of each parameter follows:</P>
 
116
<dl>
 
117
<dt><strong>type:</strong><br />
 
118
</dt>
 
119
<DD>
 
120
The type of resource.
 
121
</dd>
 
122
<P></P>
 
123
<dt><strong><a name="item_o_limit_3a">limit:</a></strong><br />
 
124
</dt>
 
125
<DD>
 
126
The maximum limit for the resource.
 
127
</dd>
 
128
</dl>
 
129
 
 
130
</body>
 
131
 
 
132
</html>