Click here to Skip to main content
Click here to Skip to main content
Go to top

Using the Microsoft Common Spell API

, 14 Jun 2001
Rate this:
Please Sign up or sign in to vote.
An introduction to using the Microsoft CSAPI.

Introduction

Searching around in MSDN trying to find how to use the MS Office spell checker, I found a "fantastic" OLE solution:

  1. Run Word
  2. Push the word to be checked into Word
  3. Get the result.

Thanks very much :(

Then I found this. Through them, I got the Microsoft Common Spell API (CSAPI).

CSAPI

To ensure I respect copyright, I cut the smallest possible example using the default dictionary only, and ignored possible error states or exceptions. You will probably need to modify it for your language and paths (I'm not reading paths from registry).

Below is some sample code that illustrates how to use the SDK.

#include "windows.h"
#include "csapi.h" //with typedef unsigned char CHAR; removed

typedef WORD (*SpellInit_fn) (SPLID FAR *lpSid,
                              WSC FAR  *lpWsc);

typedef WORD (*SpellOpenMdr_fn)(SPLID    splid,
                                LPSPATH  lpspathMain,
                                LPSPATH  lpspathExc,
                                BOOL     fCreateUdrExc,
                                BOOL     fCache,
                                LID      lidExpected,
                                LPMDRS   lpMdrs);

typedef WORD (*SpellCheck_fn)(SPLID    splid,
                              SCCC     iScc,
                              LPSIB    lpSib,
                              LPSRB    lpSrb);

typedef WORD (*SpellCloseMdr_fn)(SPLID    splid,
                                 LPMDRS   lpMdrs);

typedef WORD (*SpellTerminate_fn)(SPLID    splid,
                                  BOOL     fForce);

void main(void)
{
    int Language = 1051; //slovak

    //to be more general search thru registry:
    //Dll functional interface:
    //  HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Shared Tools\
    //           Proofing Tools\Spelling\1051\Normal\Engine
    //Mdr main directory:
    //  HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Shared Tools\
    //           Proofing Tools\Spelling\1051\Normal\Dictionary
    //Under any user directory:
    //  HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Shared Tools\
    //           Proofing Tools\Custom Dictionaries\1

    char DllName[] = 
     "C:\\Program Files\\Common Files\\Microsoft Shared\\Proof\\MSPSK32.DLL";
    char MdrName[] = 
     "C:\\Program Files\\Common Files\\Microsoft Shared\\Proof\\MSSP_SK.LEX";

    HMODULE SpellInstance = LoadLibrary(DllName);

    SpellInit_fn SpellInit = 
      (SpellInit_fn)GetProcAddress(SpellInstance, 
      "SpellInit");
    SpellOpenMdr_fn SpellOpenMdr = 
      (SpellOpenMdr_fn)GetProcAddress(SpellInstance, 
      "SpellOpenMdr");
    SpellCheck_fn SpellCheck = 
      (SpellCheck_fn)GetProcAddress(SpellInstance, 
      "SpellCheck");
    SpellCloseMdr_fn SpellCloseMdr = 
      (SpellCloseMdr_fn)GetProcAddress(SpellInstance, 
      "SpellCloseMdr");
    SpellTerminate_fn SpellTerminate = 
      (SpellTerminate_fn)GetProcAddress(SpellInstance, 
      "SpellTerminate");

    SPLID Handle;
    WSC SpecChars;
    SpecChars.bIgnore = 0;
    SpecChars.bHyphenHard = 45;
    SpecChars.bHyphenSoft = 31;
    SpecChars.bHyphenNonBreaking = 30;
    SpecChars.bEmDash = 151;
    SpecChars.bEnDash = 150;
    SpecChars.bEllipsis = 133;
    SpecChars.rgLineBreak[0] = 11;
    SpecChars.rgLineBreak[1] = 10;
    SpecChars.rgParaBreak[0] = 13;
    SpecChars.rgParaBreak[1] = 10;

    SpellInit(&Handle, &SpecChars);

    MDRS Mdrs;
    SpellOpenMdr(Handle, MdrName, NULL, FALSE, TRUE, Language, &Mdrs);

    SIB InputBuffer;
    InputBuffer.cMdr = 1;
    InputBuffer.lrgMdr = &Mdrs.mdr;
    InputBuffer.cUdr = 0;
    InputBuffer.lrgUdr = NULL;

    SRB ResultBuffer;
    ResultBuffer.cch = 1024;
    ResultBuffer.lrgsz = (char*)malloc(ResultBuffer.cch);
    ResultBuffer.cbRate = 255;
    ResultBuffer.lrgbRating = (unsigned char*)malloc(ResultBuffer.cbRate);

    InputBuffer.lrgch = "slovo"; //tested word
    InputBuffer.cch = strlen(InputBuffer.lrgch);
    InputBuffer.wSpellState = fssStartsSentence;
    SpellCheck(Handle, sccVerifyWord, &InputBuffer, &ResultBuffer);

    int Result = ResultBuffer.scrs; //scrsNoErrors

    free(ResultBuffer.lrgsz);
    free(ResultBuffer.lrgbRating);
    SpellCloseMdr(Handle, &Mdrs);
    SpellTerminate(Handle, TRUE);
    FreeLibrary(SpellInstance);
}

I have tried the above code with Office 95 and Office 97. Installing Office 2000 with English, Slovak and German languages creates a registry Spelling\1051 (slovak) and Grammar\1031 (german) entries.

BTW: My search for a similar WIN API for string comparison failed. It seems Windows knows how to use the actual language only (resp. see .NET Framework Reference, String.Compare Method (String, String, Boolean, CultureInfo)), and there is no way to hook between your application and the system to correct the MS bugs for "small markets" like my country (where exceptional vocabulary or similar solution are necessary for proper string evaluation). If you know more about this, do not hesitate to publish it.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

Share

About the Author

Tibor Blazko
Software Developer (Senior)
Slovakia Slovakia
No Biography provided

Comments and Discussions

 
Questionlink: Using the C++ Spell Checking API PinmemberTibor Blazko11-Aug-13 21:18 
GeneralCSAPI3 Pinmemberleebauer2-Nov-09 0:55 
Questionhow to complile Pinmemberleebauer21-Oct-09 6:21 
AnswerRe: how to complile PinmemberTibor Blazko25-Oct-09 0:04 
Generalcreating local language spell cheking Pinmembertedkidane1-Oct-09 7:39 
GeneralRe: creating local language spell cheking PinmemberTibor Blazko1-Oct-09 9:21 
GeneralUsing unicode chars Pinmembermita5555526-Aug-09 1:34 
GeneralRe: Using unicode chars PinmemberTibor Blazko26-Aug-09 1:39 
QuestionWhat are the license terms PinmemberDwayne Bailey28-Jan-07 7:14 
GeneralProblem Creating a New Dictionary for MS Office Sort by Position Word List Pinmembermfcuser31-Aug-04 6:45 
I do have all the resources necessary to create a new dictionary for another language that is no English. I receive a program from Microsoft to compile the list of words that I have. Everything works fine, except I have one problem. The language I want to create the dictionary for is an accented language. Microsoft provides me with a utility where I have to sort my list before create the main dictionary. I can create the main dictionary by running the utility in the command line plus my list. In order for the utility to compile my list, the list has to be sorted. Since the language in question contains words with accents and apostrophes, I have to sort the list by position. When I use a small list without accent and apostrophes, the program compiles my list without problem. I try to sort the whole list in Word, but it doesn’t work, because Word cannot sort by position. My problem now is to sort the whole list by position. I don’t want to write a program for that, because it will take more time. I wonder if there is a utility I can use or any other program to sort the list by position. I will appreciate your help or suggestion. I ask Microsoft if they have a utility that can help me to sort the list by position; they told me they don’t have one.
GeneralRe: Problem Creating a New Dictionary for MS Office Sort by Position Word List PinmemberShaheer Ahmad7-Dec-04 22:23 
GeneralRe: Problem Creating a New Dictionary for MS Office Sort by Position Word List Pinmembermfcuser8-Dec-04 2:48 
GeneralRe: Problem Creating a New Dictionary for MS Office Sort by Position Word List PinmemberShaheer Ahmad8-Dec-04 3:56 
GeneralRe: Problem Creating a New Dictionary for MS Office Sort by Position Word List Pinmembermlavaud200512-May-05 22:21 
GeneralRe: Problem Creating a New Dictionary for MS Office Sort by Position Word List Pinmembermertart14-May-05 22:18 
GeneralRe: Problem Creating a New Dictionary for MS Office Sort by Position Word List PinmemberRakeshShivanna5-Jun-06 20:50 
GeneralProblem running the code... Pinmemberdeepblue129-May-04 3:44 
GeneralRe: Problem running the code... PinmemberTibor Blazko6-Jun-04 19:59 
GeneralRe: Problem running the code... Pinmemberalfonso.gonzalez14-Jul-05 5:55 
GeneralRe: Problem running the code... PinmemberTibor Blazko15-Jul-05 5:59 
GeneralCSAPI 3 Dcoumentation Pinmemberschler6-Jan-03 0:49 
QuestionCSAPI for Office 2000 and XP? PinmemberAnonymous19-Apr-02 8:10 
AnswerRe: CSAPI for Office 2000 and XP? PinmemberTibor Blazko7-May-02 1:39 
GeneralRe: CSAPI for Office 2000 and XP? PinmemberLuzius Schneider15-May-02 3:49 
Generalspell checking problem PinmemberAnonymous13-Mar-02 1:22 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web03 | 2.8.140921.1 | Last Updated 15 Jun 2001
Article Copyright 2001 by Tibor Blazko
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid