<?xml version="1.0" ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>resource - Set resource consumption limits</title> <meta http-equiv="content-type" content="text/html; charset=utf-8" /> <link rev="made" href="mailto:bfriesen@freddy.simplesystems.org" /> </head> <body style="background-color: white"> <P><a name="__index__"></a></P> <!-- INDEX BEGIN --> <ul> <li><a href="#name">NAME</a></li> <li><a href="#synopsis">SYNOPSIS</a></li> <li><a href="#function_descriptions">FUNCTION DESCRIPTIONS</a></li> <ul> <li><a href="#acquiremagickresource">AcquireMagickResource</a></li> <li><a href="#getmagickresource">GetMagickResource</a></li> <li><a href="#liberatemagickresource">LiberateMagickResource</a></li> <li><a href="#listmagickresourceinfo">ListMagickResourceInfo</a></li> <li><a href="#setmagickresourcelimit">SetMagickResourceLimit</a></li> </ul> </ul> <!-- INDEX END --> <hr /> <P> </P> <h1><a name="name">NAME</a></h1> <P>resource - Set resource consumption limits (e.g. memory)</P> <P> </P> <hr /> <h1><a name="synopsis">SYNOPSIS</a></h1> <P>MagickPassFail <strong>AcquireMagickResource</strong>( const ResourceType type, const magick_int64_t size );</P> <P>magick_uint64_t <strong>GetMagickResource</strong>( const ResourceType type );</P> <P>void <strong>LiberateMagickResource</strong>( const ResourceType type, const magick_int64_t size );</P> <P>unsigned int <strong>ListMagickResourceInfo</strong>( FILE *file, ExceptionInfo *exception );</P> <P>void <strong>SetMagickResourceLimit</strong>( const ResourceType type, const unsigned long limit );</P> <P> </P> <hr /> <h1><a name="function_descriptions">FUNCTION DESCRIPTIONS</a></h1> <P> </P> <h2><a name="acquiremagickresource">AcquireMagickResource</a></h2> <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>MagickPassFail AcquireMagickResource ( const <A HREF="types.html#ResourceType">ResourceType</A> type, const magick_int64_t size ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong><a name="item_o_type_3a">type:</a></strong> <DD> <P>The type of resource.</P> </dd> </li> <dt><strong><a name="item_o_size_3a">size:</a></strong> <DD> <P>The number of bytes needed from for this resource.</P> </dd> </li> </dl> <P> </P> <h2><a name="getmagickresource">GetMagickResource</a></h2> <blockquote>GetMagickResource() returns the current consumption level for the specified resource type. </blockquote><blockquote>The format of the GetMagickResource() method is: </blockquote><blockquote>magick_uint64_t GetMagickResource ( const <A HREF="types.html#ResourceType">ResourceType</A> type ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong>type:</strong> <DD> <P>The type of resource.</P> </dd> </li> </dl> <P> </P> <h2><a name="liberatemagickresource">LiberateMagickResource</a></h2> <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> <dl> <dt><strong>type:</strong> <DD> <P>The type of resource.</P> </dd> </li> <dt><strong>size:</strong> <DD> <P>The size of the resource.</P> </dd> </li> </dl> <P> </P> <h2><a name="listmagickresourceinfo">ListMagickResourceInfo</a></h2> <P>Method ListMagickResourceInfo lists the resource info to a file.</P> <P>The format of the ListMagickResourceInfo method is:</P> <blockquote>unsigned int ListMagickResourceInfo ( FILE *file, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows.</P> <dl> <dt><strong><a name="item_o_file_3a">file:</a></strong> <DD> <P>An pointer to a FILE.</P> </dd> </li> <dt><strong><a name="item_o_exception_3a">exception:</a></strong> <DD> <P>Return any errors or warnings in this structure.</P> </dd> </li> </dl> <P> </P> <h2><a name="setmagickresourcelimit">SetMagickResourceLimit</a></h2> <blockquote>SetMagickResourceLimit() sets the limit for a particular resource. The units for resource types are as follows: </blockquote><pre> DiskResource -- Gigabytes FileResource -- Open files MapResource -- Megabytes MemoryResource -- Megabytes PixelsResource -- Megapixels =for html <blockquote>The format of the SetMagickResourceLimit() method is: </blockquote></pre> <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> <dl> <dt><strong>type:</strong> <DD> <P>The type of resource.</P> </dd> </li> <dt><strong><a name="item_o_limit_3a">limit:</a></strong> <DD> <P>The maximum limit for the resource.</P> </dd> </dl> </body> </html>
