Chip 2000 May

home *** CD-ROM | disk | FTP | other *** search

/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _aa5bb4342db07161e8eeab09b3276419 < prev next >

Wrap

Text File | 2000-03-23 | 13.2 KB | 450 lines

<HTML> <HEAD> <TITLE>PerlEz - PerlEz host DLL</TITLE> <LINK REL="stylesheet" HREF="../../../Active.css" TYPE="text/css"> <LINK REV="made" HREF="mailto:"> </HEAD> <BODY> <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%> <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc"> PerlEz - PerlEz host DLL </TD></TR> </TABLE> <A NAME="__index__"></A>  <UL> <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI> <LI><A HREF="#description">DESCRIPTION</A></LI> <UL> <LI><A HREF="#datatypes">Datatypes</A></LI> <LI><A HREF="#perlezcreate">PerlEzCreate</A></LI> <LI><A HREF="#perlezdelete">PerlEzDelete</A></LI> <LI><A HREF="#perlezevalstring">PerlEzEvalString</A></LI> <LI><A HREF="#perlezcall1">PerlEzCall1</A></LI> <LI><A HREF="#perlezcall2">PerlEzCall2</A></LI> <LI><A HREF="#perlezcall4">PerlEzCall4</A></LI> <LI><A HREF="#perlezcall8">PerlEzCall8</A></LI> <LI><A HREF="#perlezcall">PerlEzCall</A></LI> <LI><A HREF="#perlezcallcontext">PerlEzCallContext</A></LI> <LI><A HREF="#perlezsetmagicscalarfunctions">PerlEzSetMagicScalarFunctions</A></LI> <LI><A HREF="#perlezsetmagicscalarname">PerlEzSetMagicScalarName</A></LI> <LI><A HREF="#format string">Format String</A></LI> </UL> <LI><A HREF="#authors">AUTHORS</A></LI> </UL>  <HR> <H1><A NAME="name">NAME</A></H1> PerlEz - PerlEz host DLL <HR> <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1> <UL> <LI>Windows</LI> </UL> <HR> <H1><A NAME="description">DESCRIPTION</A></H1> This document attempts to describe the functions of the PerlEz host Dynamicly Linked Library (DLL). Please refer any questions or comments to the author below. <H2><A NAME="datatypes">Datatypes</A></H2> PerlEz has one specific data type, PERLEZHANDLE; this is a non-zero handle to a Perl interpreter that is created and can be accessed by the routines described below. <H2><A NAME="perlezcreate">PerlEzCreate</A></H2> <PRE> PERLEZHANDLE PerlEzCreate(LPCSTR lpFileName, LPSTR lpOptions);</PRE> <DL> <DT><A NAME="item_DESCRIPTION%3A">DESCRIPTION:</A> <DD> <LI> Creates a Perl interpreter. The return value is required parameter for all subsequent æPerlEzÆ calls. Multiple interpreters can be created, but only one will be executing at a time. <DT><A NAME="item_PARAMS%3A">PARAMS:</A> <DD> <LI> lpFileName a pointer to a ASCIIZ string that is the name of a file; can be NULL <LI> lpOptions a pointer to a ASCIIZ string that are the command line options that will be provided before the script; can be NULL. This parameter is used for setting @INC or debugging. <DT><A NAME="item_RETURNS%3A">RETURNS:</A> <DD> <LI> A non zero handle to a Perl interpreter if successful; zero otherwise. Call PerlEzDelete to release this handle. See also <A HREF="#perlezdelete">PerlEzDelete</A> </DL> <H2><A NAME="perlezdelete">PerlEzDelete</A></H2> <PRE> BOOL PerlEzDelete(PERLEZHANDLE hHandle);</PRE> <DL> <DT>DESCRIPTION: <DD> <LI> Deletes a previously created Perl interpreter. Releases all resources allocated by PerlEzCreate. <DT>PARAMS: <DD> <LI> hHandle a handle returned by the call to PerlEzCreate <DT>RETURNS: <DD> <LI> True if no error false otherwise. </DL> <H2><A NAME="perlezevalstring">PerlEzEvalString</A></H2> <PRE> int PerlEzEvalString(PERLEZHANDLE hHandle, LPCSTR lpString, LPSTR lpBuffer, DWORD dwBufSize);</PRE> <DL> <DT>DESCRIPTION: <DD> <LI> Evaluates the string a returns the result in lpBuffer. If there is an error $! is returned in lpBuffer. <DT>PARAMS: <DD> <LI> hHandle a handle returned by the call to PerlEzCreate <LI> lpString a pointer to the ASCIIZ string to evaluate <LI> lpBuffer a pointer to the buffer where the result will be placed <LI> dwBufSize the size in bytes of the space where lpBuffer points <DT>RETURNS: <DD> <LI> A zero if no error; otherwise error code. </DL> <H2><A NAME="perlezcall1">PerlEzCall1</A></H2> <PRE> int PerlEzCall1(PERLEZHANDLE hHandle, LPCSTR lpFunction, LPSTR lpBuffer, DWORD dwBufSize, LPCSTR lpFormat, LPVOID lpVoid);</PRE> <DL> <DT>DESCRIPTION: <DD> <LI> Calls the function lpFunction and returns the result in the buffer lpBuffer. <DT>PARAMS: <DD> <LI> hHandle a handle returned by the call to PerlEzCreate <LI> lpFunction a pointer name of the function to call <LI> lpBuffer a pointer to the buffer where the result will be placed <LI> dwBufSize the size in bytes of the space where lpBuffer points <LI> lpFormat a pointer to the parameter specifier; can be NULL. See <A HREF="#format string">Format String</A> <LI> lpVoid a pointer to a parameter will be interpreted based on lpFormat <DT>RETURNS: <DD> <LI> A zero if no error; otherwise error code. </DL> <H2><A NAME="perlezcall2">PerlEzCall2</A></H2> <PRE> int PerlEzCall2(PERLEZHANDLE hHandle, LPCSTR lpFunction, LPSTR lpBuffer, DWORD dwBufSize, LPCSTR lpFormat, LPVOID lpVoid1, LPVOID lpVoid2);</PRE> <DL> <DT>DESCRIPTION: <DD> <LI> Calls the function lpFunction and returns the result in the buffer lpBuffer. <DT>PARAMS: <DD> <LI> hHandle a handle returned by the call to PerlEzCreate <LI> lpFunction a pointer name of the function to call <LI> lpBuffer a pointer to the buffer where the result will be placed <LI> dwBufSize the size in bytes of the space where lpBuffer points <LI> lpFormat a pointer to the parameter specifier; can be NULL. See <A HREF="#format string">Format String</A> <LI> lpVoid1...2 pointers to parameters that will be interpreted based on lpFormat <DT>RETURNS: <DD> <LI> A zero if no error; otherwise error code. </DL> <H2><A NAME="perlezcall4">PerlEzCall4</A></H2> <PRE> int PerlEzCall4(PERLEZHANDLE hHandle, LPCSTR lpFunction, LPSTR lpBuffer, DWORD dwBufSize, LPCSTR lpFormat, LPVOID lpVoid1, LPVOID lpVoid2, LPVOID lpVoid3, LPVOID lpVoid4);</PRE> <DL> <DT>DESCRIPTION: <DD> <LI> Calls the function lpFunction and returns the result in the buffer lpBuffer. <DT>PARAMS: <DD> <LI> hHandle a handle returned by the call to PerlEzCreate <LI> lpFunction a pointer name of the function to call <LI> lpBuffer a pointer to the buffer where the result will be placed <LI> dwBufSize the size in bytes of the space where lpBuffer points <LI> lpFormat a pointer to the parameter specifier; can be NULL. See <A HREF="#format string">Format String</A> <LI> lpVoid1...4 pointers to parameters that will be interpreted based on lpFormat <DT>RETURNS: <DD> <LI> A zero if no error; otherwise error code. </DL> <H2><A NAME="perlezcall8">PerlEzCall8</A></H2> <PRE> int PerlEzCall8(PERLEZHANDLE hHandle, LPCSTR lpFunction, LPSTR lpBuffer, DWORD dwBufSize, LPCSTR lpFormat, LPVOID lpVoid1, LPVOID lpVoid2, LPVOID lpVoid3, LPVOID lpVoid4, LPVOID lpVoid5, LPVOID lpVoid6, LPVOID lpVoid7, LPVOID lpVoid8);</PRE> <DL> <DT>DESCRIPTION: <DD> <LI> Calls the function lpFunction and returns the result in the buffer lpBuffer. <DT>PARAMS: <DD> <LI> hHandle a handle returned by the call to PerlEzCreate <LI> lpFunction a pointer name of the function to call <LI> lpBuffer a pointer to the buffer where the result will be placed <LI> dwBufSize the size in bytes of the space where lpBuffer points <LI> lpFormat a pointer to the parameter specifier; can be NULL. See <A HREF="#format string">Format String</A> <LI> lpVoid1...8 pointers to parameters that will be interpreted based on lpFormat <DT>RETURNS: <DD> <LI> A zero if no error; otherwise error code. </DL> <H2><A NAME="perlezcall">PerlEzCall</A></H2> <PRE> int PerlEzCall(PERLEZHANDLE hHandle, LPCSTR lpFunction, LPSTR lpBuffer, DWORD dwBufSize, LPCSTR lpFormat, ...);</PRE> <DL> <DT>DESCRIPTION: <DD> <LI> Calls the function lpFunction and returns the result in the buffer lpBuffer. <DT>PARAMS: <DD> <LI> hHandle a handle returned by the call to PerlEzCreate <LI> lpFunction a pointer name of the function to call <LI> lpBuffer a pointer to the buffer where the result will be placed <LI> dwBufSize the size in bytes of the space where lpBuffer points <LI> lpFormat a pointer to the parameter specifier; can be NULL. See <A HREF="#format string">Format String</A> <LI> ... parameters to be interpreted based on lpFormat <DT>RETURNS: <DD> <LI> A zero if no error; otherwise error code. </DL> <H2><A NAME="perlezcallcontext">PerlEzCallContext</A></H2> <PRE> int PerlEzCallContext(PERLEZHANDLE hHandle, LPCSTR lpFunction, LPVOID lpContextInfo, LPSTR lpBuffer, DWORD dwBufSize, LPCSTR lpFormat, ...);</PRE> <DL> <DT>DESCRIPTION: <DD> <LI> Calls the function lpFunction and returns the result in the buffer lpBuffer. <DT>PARAMS: <DD> <LI> hHandle a handle returned by the call to PerlEzCreate <LI> lpFunction a pointer name of the function to call <LI> lpContextInfo context info for magic fetch and store functions <LI> lpBuffer a pointer to the buffer where the result will be placed <LI> dwBufSize the size in bytes of the space where lpBuffer points <LI> lpFormat a pointer to the parameter specifier; can be NULL. See <A HREF="#format string">Format String</A> <LI> ... parameters to be interpreted based on lpFormat <DT>RETURNS: <DD> <LI> A zero if no error; otherwise error code. </DL> <H2><A NAME="perlezsetmagicscalarfunctions">PerlEzSetMagicScalarFunctions</A></H2> <PRE> int PerlEzSetMagicScalarFunctions(PERLEZHANDLE hHandle, LPFETCHVALUEFUNCTION lpfFetch, LPSTOREVALUEFUNCTION lpfStore);</PRE> <DL> <DT>DESCRIPTION: <DD> <LI> Sets the call back function pointers for magic scalar variables. <DT>PARAMS: <DD> <LI> hHandle a handle returned by the call to PerlEzCreate <LI> lpfFetch a pointer to the call back function for fetching a string. if lpfFetch is NULL, then the scalar is write only. <LI> lpfStore a pointer to the call back function for storinging a string. if lpfStore is NULL, then the scalar is read only. <DT>RETURNS: <DD> <LI> A zero if no error; otherwise error code. NOTE: if lpfFetch and lpfStore are both NULL, then it is an error. See also <A HREF="#perlezsetmagicscalarname">PerlEzSetMagicScalarName</A> </DL> <H2><A NAME="perlezsetmagicscalarname">PerlEzSetMagicScalarName</A></H2> <PRE> int PerlEzSetMagicScalarName(PERLEZHANDLE hHandle, LPCSTR pVariableName);</PRE> <DL> <DT>DESCRIPTION: <DD> <LI> Creates the variable if it does not exists and sets it to be tied to the call back function pointer for magic variables. <DT>PARAMS: <DD> <LI> hHandle a handle returned by the call to PerlEzCreate. <LI> pVariableName a pointer to the name of the variable. <DT>RETURNS: <DD> <LI> A zero if no error; otherwise error code. See also <A HREF="#perlezsetmagicscalarfunctions">PerlEzSetMagicScalarFunctions</A> </DL> <H2><A NAME="format string">Format String</A></H2> The format string is a series of characters that represents the type of parameters being supplied. <DL> <DT><A NAME="item_s">s</A> <DD> <LI> this parameter is a pointer to a null terminated string. <DT><A NAME="item_i">i</A> <DD> <LI> this parameter is to be considered an integer. <DT><A NAME="item_d">d</A> <DD> <LI> this parameter is to be considered a double. <DT><A NAME="item_l%5Bs_%7C_i_%7C_d%5Dx">l[s | i | d]x</A> <DD> <LI> the next 'x' parameters will be put into an anonymous list of the type specifed. Either 's', 'i', or 'd' </DL> <HR> <H1><A NAME="authors">AUTHORS</A></H1> This document is maintained by Douglas Lankshear <<A HREF="mailto:dougl@ActiveState.com">dougl@ActiveState.com</A>> <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%> <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc"> PerlEz - PerlEz host DLL </TD></TR> </TABLE> </BODY> </HTML>