臼齿蛀牙要不要拔掉:使用c++开发excel插件(第4章编写一个完整的xll)

如果使用自动加载，你需要把xll文件放置到“C:/Documents and Settings/wxy/Application Data/Microsoft/AddIns”目录下，或者放到office的安装目录下的“XLSTART”目录中，如果没有此目录，你可以新建一个。但“XLSTART”目录的位置会因office的版本不同而不同，在office2003中它的路径是“安装目录/Microsoft Office/OFFICE11/XLSTART”。使用自动加载的xll宏并不显示在加载宏管理器中。当然它必须也是有效的加载宏。当你启动excel时，excel会自动扫描这些文件夹，并加载文件夹中所有可用的加载宏文件。

当你加载一个xll加载宏时，excel主要执行以下操作：

2        调用xlAddInManagerInfo注册加载宏的名称。

2        调用xlAutoOpen初始化xll并注册自定义函数，添加菜单、按钮等。

2、 激活加载宏

我们在前面看到，当一个xll加载宏第一次被宏管理器加载时，默认是选中的，这表明这个宏此时是被激活的，xll宏一旦被激活就意味着它的函数或方法可以被调用了，此时我们打开插入函数窗口（菜单插入->函数），在其中我们就可以找到我们自定义的函数类别及这个类别下的所有函数。

如果你不想要这些函数执行，那么你可以取消加载宏管理器中的对应选项，这时对应的xll宏就被取消了激活状态，excel中的所有对相关函数的引用都将不可用，虽然你取消了激活状态，但有时还会在插入函数对话框中仍然看到这个xll文件中的函数，但这并不代表函数仍然能用，因为如果你此时调用函数，excel不会让你输入任何参数。通常当你使用的函数名在不同xll加载宏中同时存在时，取消其它发生冲突的xll宏就显得非常重要了。

当你要激活一个xll加载宏，excel执行以下操作：

2        调用xlAutoOpen初始化xll并添加菜单、按钮，注册函数等。

1、 删除加载宏

当使用加载宏管理器加载xll宏时，excel会把xll文件的路径保存在注册表中，在excel下次启动时excel会按照这个路径寻找对应的文件，但是如果对应的动态链接库已被删除或路径发生变化，excel在启动时会提示文件找不到，但此时excel并不会删除其在excel加载宏管理器中的对应项。直到你打开加载宏管理器并改变其激活状态时才提示是否要删除未找到的项，我不是很理解excel为什么要这么设计。如果在加载宏管理器里有个删除按钮，我觉得会好用许多。

2、 创建加载宏

从前面已经看到，并不是所有的动态链接库都可以做为excel加载宏使用，那么excel是如何判别一个动态链接库是不是加载宏呢，又是如何取得加载宏内部的自定义函数并调用它呢。

Excel加载宏xll中必须实现一些特定的导出函数，通过这些函数excel获得xll的信息并把xll文件加载到excel中，同样excel通过这些特定的函数关闭或移除xll加载宏。Xll也是通过这些特定的函数与excel交互，并把自定义的函数和方法注册进excel中。其中一些函数是实现xll加载宏必不可少的，excel也是通过查找这些函数来判断一个动态链接库是否是可用的xll加载宏。下面列出了创建一个xll加载宏常要实现并导出的几个特定函数：

2        xlAutoOpen

2        xlAutoClose

2        xlAutoAdd

2        xlAutoRemove

2        xlAddInManagerInfo

2        xlAutoFree

注意，这些函数并不区分大小写，其中xlAutoOpen，xlAutoClose和xlAddInManagerInfo是必不可少的三个导出函数。

       通过名字名字并不能看出excel是何时调用哪个函数，下面我们将通过一个表格列出这些函数的调用次序，以及调用的时间：

执行状态

这时调用的函数

打开加载宏管理器

xlAddInManagerInfo

在加载宏管理器中选中加载宏，即激活加载宏

xlAutoAdd

xlAutoOpen

在加载宏管理器中取消选中加载宏，即取消激活加载宏

xlAutoRemove

xlAutoClose

第一次载入加载宏

xlAddInManagerInfo

xlAutoAdd

xlAutoOpen

启动excel时，并且xll宏在之前以被加载宏管理器加载

xlAutoOpen

关闭excel，但此时xll宏并没有被激活

不执行任何函数

关闭excel，并且xll宏是被激活的

xlAutoClose

xlAddInManagerInfo

关闭excel，但当提示是否保存时，选择了取消按钮

xlAutoClose

通过上面的表格我们知道了excel在操作xll加载宏是所需调用执行的函数，接下来我们将逐一介绍如何实现这些函数。

1、 最基本的加载宏函数

在这一节中我们将逐一介绍前面提到的几个最基本的函数，了解了这些函数的用法，就可以编写一个简单的xll加载宏了。每个函数都会有一个例子代码，这些代码是来自“ExcelAddin”工程中，你可以在光盘上找到“ExcelAddin”工程。

1、  xlAutoOpen

函数原形：int __stdcall xlAutoOpen(void)

当xll加载宏被加载到excel中时调用这个函数。在这个函数中加入任何需要初始化的操作，比如，注册函数，添加菜单、按钮等等。如果函数执行成功返回整数1。为了更好的阅读程序可以定义一个宏或常量表示函数是否执行成功。

下面的例子函数在执行时会在excel中注册一个“MyFunc”函数和一个“MyMethod”方法，并在excel中添加一个菜单，如果函数执行成功，你就可以在excel调用“MyFunc”函数和“MyMethod”方法，并可以看到excel界面上增加一个“MyMenu”的菜单。

int __stdcall xlAutoOpen(void)

{    

       MessageBox(NULL,_T("xlAutoOpen"),_T("xll"),MB_OK);

       if (true == m_Initialize)

       {

              return(XLL_SUCCESS);

       }

       int    iNum      =     0;

       static       int    iErr  =     0;

       //从新设置字符串

       for (iNum=0;iNum<9;iNum++)

       {

              func[iNum][0]       =     (BYTE)(strlen(func[iNum])-1);

       }

       for (iNum=0;iNum<10;iNum++)

       {

              menu[iNum][0]      =     (BYTE)(strlen(menu[iNum])-1);

       }

       for (iNum=0;iNum<9;iNum++)

       {

              method[iNum][0]   =     (BYTE)(strlen(method[iNum])-1);

       }

       //获得xll的名字

       static XLOPER      xllName;

       Excel4(xlGetName,&xllName,0);

       //注册“MyFunc”函数

       iErr = Excel4(xlfRegister,0,10,(LPXLOPER)&xllName,

              (LPXLOPER)TempStr(func[0]),

              (LPXLOPER)TempStr(func[1]),

              (LPXLOPER)TempStr(func[2]),

              (LPXLOPER)TempStr(func[3]),

              (LPXLOPER)TempStr(func[4]),

              (LPXLOPER)TempStr(func[5]),

              (LPXLOPER)TempStr(func[6]),

              (LPXLOPER)TempStr(func[7]),

              (LPXLOPER)TempStr(func[8]),

              (LPXLOPER)TempStr(func[9])

              );

       if (iErr != xlretSuccess)

       {

              MessageBox(NULL,"Can not register fun!","",MB_OK);

              return(XLL_FAIL);

       }

       //注册“MyMethod”方法

       iErr = Excel4(xlfRegister,0,6,(LPXLOPER)&xllName,

              (LPXLOPER)TempStr(method[0]),

              (LPXLOPER)TempStr(method[1]),

              (LPXLOPER)TempStr(method[2]),

              (LPXLOPER)TempStr(method[3]),

              (LPXLOPER)TempStr(method[4]),

              (LPXLOPER)TempStr(method[5])

              );

       if (iErr != xlretSuccess)

       {

              MessageBox(NULL,"Can not register Method!","",MB_OK);

              return(XLL_FAIL);

       }

       //释放xllName所占用的空间

       Excel4(xlFree,0,1,(LPXLOPER)&xllName);

       nMenuItems   =     2;

       static XLOPER xMenu;

       static XLOPER xMenuList[10*5];

       //设置菜单参数

       xMenu.xltype  =     xltypeMulti;

       xMenu.val.array.lparray  =     &xMenuList[0];

       xMenu.val.array.rows    =     nMenuItems;

       xMenu.val.array.columns      =     5;

       for (iNum=0;iNum<10;iNum++)

       {

              xMenuList[iNum].xltype       =     xltypeStr;

              xMenuList[iNum].val.str       =     menu[iNum];

       }

       //注册菜单

       Excel4(xlfAddMenu,0,2,TempNum(1),(LPXLOPER)&xMenu);

       m_Initialize     =     true;

       return(XLL_SUCCESS);

}

2、  xlAutoClose

函数原形是：int __stdcall xlAutoClose(void)

Excel会在关闭或卸载xll加载宏时调用此函数。当执行这个函数时意味着你要关闭xll加载宏并且不再容许excel调用这个加载宏中的函数或方法，所以你可以在这个函数中实现释放xll加载宏占用的内存以及注销自定义函数。你也可以在这个函数执行时删除菜单，按钮等。

下面的例子函数在执行时会把“MyMenu”菜单项从excel中移除。

int __stdcall xlAutoClose(void)

{

       if (false == m_Initialize)

       {

              return(XLL_SUCCESS);

       }

       //删除菜单

       char chMenu[]       =     " MyMenu";

       Excel4(xlfDeleteMenu,0,2,TempNum(1),TempStr(chMenu));

       m_Initialize     =     true;

       return(XLL_SUCCESS);

}

3、  xlAutoAdd

函数原形是：int __stdcall xlAutoAdd(void)

当通过加载宏管理器来加载xll宏和在加载宏管理器中激活xll宏时会调用此函数，但是，调用此函数的时候也会调用xlAutoOpen函数，所以你可以忽略此函数并把相关操作放在xlAutoOpen函数中执行。

       下面的例子函数通过调用xlAutoOpen执行初始化操作。

int __stdcall xlAutoAdd(void)

{

       if (false == m_Initialize)

       {

              xlAutoOpen();

       }

       return(XLL_SUCCESS);

}

4、  xlAutoRemove

当xll加载宏被关闭或被取消激活状态时，excel会调用此函数，但是这个函数同样也可以被忽略，因为在调用它的时候，也会调用xlAutoClose函数。

下面的例子函数在被调用时除显示一个提示对话框外不执行任何其他操作

int __stdcall xlAutoRemove(void)

{

       MessageBox(NULL,"xlAutoRemove","XLL",MB_OK);

       return(XLL_SUCCESS);

}

5、  xlAddInManagerInfo

函数原形是：LPXLOPER __stdcall xlAddInManagerInfo(LPXLOPER xAction)

Excel会在第一次打开加载宏管理器时调用此函数，从中获得有关xll文件的信息并把注册名显示在加载宏管理器中，如果xll加载宏中并没有显示注册xll加载宏名，则在加载宏管理器中显示它的文件名（不包括扩展名）。函数返回一个字符串xloper的指针，其中字符串是要注册的名字。

下面的函数显示的注册了当前的xll加载宏的名字为“My Add-in!!!!”。

LPXLOPER __stdcall xlAddInManagerInfo(LPXLOPER xAction)

{

       static XLOPER xInfo,xIntAction;

       //find out what action must be taken

       Excel4(xlCoerce,&xIntAction,2,xAction,TempInt(xltypeInt));

       strcpy(xllName," My Add-in!!!!");

       //Set title if asked

       if (xIntAction.val.w == 1)

       {

              xInfo.xltype    =     xltypeStr;

              xInfo.val.str    =     xllName;

              xInfo.val.str[0]      =     (char)strlen(&xInfo.val.str[1]);

       }

       else

       {

              xInfo.xltype    =     xltypeErr;

              xInfo.val.err   =     xlerrValue;

       }

//     Excel4(xlFree,0,1,(LPXLOPER)&xInfo);

       return((LPXLOPER)&xInfo);

}

如果这个函数执行成功则在加载宏管理器中出现一项“My Add-in!!!!”。如图

1、  xlAutoFree

函数原形是：void __stdcall xlAutoFree(xloper *)

当xll加载宏中的一个函数返回给excel一个指向 xloper的指针时，它被调用并把xloper指针传作为参数传递给它。通过它释放xll动态分配的xloper变量所占用的内存。通常一个函数需要返回xloper指针时，那么指针所占用的内存不能在返回前被是否，否则返回的指针将指向无效地址。但是已经分配的动态内存必须在合适的时候被释放，否则就会造成内存泄露。我们可以给要释放的xloper变量的中设置xlbitDllFree状态位并通过xlAutoFree函数来解决这个问题。

下面的例子函数功能是释放一个xloper指针，这个指针所指向的xloper可能是字符串，数组，或是一个范围的应用。函数分别对不同类型的xloper执行释放内存的操作。

void __stdcall xlAutoFree(XLOPER *pXloper)

{

       if (pXloper->xltype & xltypeMulti)

       {

              int size = pXloper->val.array.rows * pXloper->val.array.columns;

              XLOPER *p = pXloper->val.array.lparray;

              for (;size-- > 0;p++)

              {

                     if (p->xltype & (xlbitDLLFree | xlbitXLFree))

                     {

                            xlAutoFree(p);

                     }

              }

              if (pXloper->xltype & xlbitDLLFree)

              {

                     Excel4(xlFree,0,1,pXloper->val.array.lparray);

              }

       }

       else if (pXloper->xltype == (xltypeStr | xlbitDLLFree))

       {

              Excel4(xlFree,0,1,pXloper->val.str);

       }

       else if (pXloper->xltype == (xltypeRef | xlbitDLLFree))

       {

       }

       else if (pXloper->xltype | xlbitXLFree)

       {

              Excel4(xlFree,0,1,pXloper);

       }

}

2、 创建一个完整的xll加载宏

你已经初步了解了一个简单xll加载宏所应该包含的内容，即上一节所介绍的函数。现在我们就来创建一个最简单的xll加载宏，其实就是把上面所讲的代码编译成xll加载宏。

2        首先创建一个空win32 dll工程“ExcelAddin”，创建方法可以参考第3章的第4节“编写一个简单的动态链接库”

2        复制xlcall.h和xlcall32.lib文件到工程目录下面，并把xlcall.h文件加入到工程中，在工程链接属性中加入xlcall32.lib，你可以通过菜单project->setting打开工程配置对话框，然后在Link属性页中的“Object/library modules：”项中加入xlcall32.lib名称。

2        创建ExcelAddin.h文件，在这个文件中加入全局变量以及对函数的定义。下面是对这个文件中一些主要的代码的说明。

         首先定义一些程序中经常用到的常量和缓存区

const int  XLL_SUCCESS     =     1;                                //定义函数执行成功

const int  XLL_FAIL      =     0;                                //定义函数执行失败

#define MEMORYSIZE 1024                                           //定义缓存区大小

char m_memBuffer[MEMORYSIZE];                        //自定义一个缓存区

int           m_memOffset =     0;                                       // Offset of next memory block to allocate

static       string      m_strMsg;                                         //定义保存提示字符串的变量

static       char xllName[20];                               //保存此xll在excel中注册名

         由于注册一个函数需要的参数比较多，所以我们把这些参数保存在一个二维数组中，注意所有的字符串前面都应留出一个空格，这是因为这个位置需要保存字符串的长度。

static char func[10][20] = {

                                          " MyFunc",                          //xll中函数名

                                          " ",                               //参数描述符

                                          " MyFunc",                          //在excel中的显示的名字

                                          " 参数1,参数2",                 //参数提示字符串

                                          " 1",                             //宏类型，1为函数，2为命令

                                          " MyCat",                            //此函数所在的类别

                                          " ",                               //快捷键，只有在命令类型才可用

                                          " ",                               //帮助的引用字符串

                                          " ",                               //函数所在帮组的描述字符串的编号

                                          " "                                       //第一个参数的描述，此后的其他参数顺序为第二个，第三个，依次类推

                                          };

         定义一个方法，各个参数的含义和定义函数的参数意义一样，只是在宏类型位置处的值为2，即为方法宏。

static char method[6][20] = {

                                          " MyMethod",

                                          " ",

                                          " MyMethod",

                                          " ",

                                          " 2",

                                          " "

                                          };

         定义一个菜单，

static char menu[10][30] = {

                                          " &MyMenu",

                                          " ",

                                          " ",

                                          " wxy's xll",

                                          " ",

                                          " &MySubMenu",

                                          " MyMethod",

                                          " ",

                                          " Message of the dat!",

                                          " "

                                          };

         定义函数：

//定义xll与excel的接口函数

int    __stdcall  xlAutoOpen(void);                //初始化xll，并注册函数，方法等

int    __stdcall  xlAutoAdd(void);

int    __stdcall  xlAutoClose(void);                //关闭xll，

int    __stdcall  xlAutoRemove(void);

LPXLOPER __stdcall    xlAddInManagerInfo(LPXLOPER xAction);

void __stdcall  xlAutoFree(XLOPER *pXloper);

//自定义函数及方法

int           __stdcall  MyMethod();

long __stdcall  MyFunc(long parm1,long parm2);

LPSTR    GetTempMemory(int iBytes);                      //获得指定数量的缓存区的指针

//获得含有指定值的xloper变量指针

LPXLOPER TempNum(double d);                                         

LPXLOPER TempStr(LPSTR lpstr);

LPXLOPER TempInt(short int i);

2        创建ExcelAddin.cpp文件，在这个文件中加入对ExcelAddin.h文件中函数的实现代码。对于xlAutoOpen，xlAutoClose等的代码我们已在上一节中介绍过，这里就不再重复。这里需要实现自定义的函数“MyFunc”和自定义的方法“MyMethod”

MyFunc函数在被调用时通过一个对话框显示了传递的参数，并返回两个参数的乘积。

long __stdcall MyFunc(long parm1,long parm2)

{

       static       char chTemp[100];

       sprintf(chTemp,"%ld and %ld",parm1,parm2);

       m_strMsg       =     _T("parameter is ");

       m_strMsg       +=   chTemp;

       MessageBox(NULL,m_strMsg.c_str(),"MyFunc",MB_OK);

       return (parm1 * parm2);

}

MyMethod方法在被调用时显示一个字符串表示它正在被调用。

int __stdcall MyMethod()

{

       m_strMsg       =     _T("this is a command");

       MessageBox(NULL,m_strMsg.c_str(),_T("MyMethod"),MB_OK);

       return(0);

}

       在这个文件中，你还会看到其它几个函数GetTempMemory，TempNum，TempStr，TempInt，这几个函数都是用来操作缓存区的，我们将在以后章节中介绍，你可以暂时不必看它们。

2        为了不让编译器修饰函数名，我们需要使用.def文件导出excel所需的函数名。创建一个ExcelAddin.def文件并在文件中加入如下代码：

LIBRARY      "ExcelAddin"

DESCRIPTION  'ExcelAddin Windows Dynamic Link Library'

EXPORTS

    ; Explicit exports can go here

       xlAutoOpen

       xlAutoAdd

       xlAutoClose

       xlAutoRemove

       xlAddInManagerInfo

       xlAutoFree

       MyMethod

       MyFunc

2        在工程更改输出文件的名称，使编译器直接输出xll文件，然后在可执行文件设置项里填入你的excel的全路径，并在下面的参数列表栏里填入你的xll文件路径，如图所示：

2        一切就绪，按F7编译，如果顺利在输出目录里就会看到一个xll文件。

2        最后按F5执行excel，由于我们把xll文件设置成了参数，此时excel启动时会同时加载我们的xll文件，如果程序执行顺利，则会在启动后的excel中看到我们设置的菜单“MyMenu”。执行菜单下的子菜单“MySubMenu”命令。如果弹出如下对话框则表明“MyMethod”方法注册成功了。

再使用插入函数对话框插入我们自定义的函数，如果函数执行成功，那么恭喜你，你已经创建了一个完整的xll加载宏。