Uporaba dokumentacije SOLIDWORKS API Help
Uporaba dokumentacije SOLIDWORKS API Help
Kaj lahko najdemo v SOLIDWORKS API Help dokumentaciji in kako nam lahko pomaga pri API programiranju?
Re: Uporaba dokumentacije SOLIDWORKS API Help
SOLIDWORKS API Help je obsežna dokumentacija o API objektih in funkcijah ter za večino teh vsebuje tudi primere uporabe. Ponuja informacije o vseh komponentah znotraj API-ja in omogoča boljše razumevanje API objektnega modela.
Informacije znotraj API Help dokumenta najlažje pridobimo s pomočjo iskanja. Iščemo lahko po specifičnih objektih ali metodah, ki smo jih opazili na primer med snemanjem makrojev in bi želeli izvedeti dodatne informacije. Lahko pa problem opišemo in preko rezultatov najdemo primeren objekt, metodo ali kar celoten primer, ki ta problem reši.
Ko najdete članek, ki bi lahko bil uporaben je pomembno vedeti v katero kategorijo spada:
Vmesnik IModelDoc2 navaja »ISldWorks::ActiveDoc« kot enega njegovih predhodnikov (»Accessor«). To pomeni, da se v vmesniku ISldWorks nahaja metoda ActiveDoc, ki vrne objekt tipa ModelDoc2.
Vsak članek tipa »Interface« vsebuje povezavo »Members«, ki navaja vse lastnosti in metode do katerih lahko preko vmesnika dostopamo.
Ko preiskujete API Help datoteko bodite pozorni na sporočila »Obsolete. Superseded by ...«. To so zastarele metode, ki še vedno delujejo, vendar so bolj omejene in lahko pride tudi do nepričakovanih napak, ki so v novejših verzijah že odpravljene.
Informacije znotraj API Help dokumenta najlažje pridobimo s pomočjo iskanja. Iščemo lahko po specifičnih objektih ali metodah, ki smo jih opazili na primer med snemanjem makrojev in bi želeli izvedeti dodatne informacije. Lahko pa problem opišemo in preko rezultatov najdemo primeren objekt, metodo ali kar celoten primer, ki ta problem reši.
Ko najdete članek, ki bi lahko bil uporaben je pomembno vedeti v katero kategorijo spada:
- 1. Interface (vmesnik oz. objekt)
Vmesnik IModelDoc2 navaja »ISldWorks::ActiveDoc« kot enega njegovih predhodnikov (»Accessor«). To pomeni, da se v vmesniku ISldWorks nahaja metoda ActiveDoc, ki vrne objekt tipa ModelDoc2.
Vsak članek tipa »Interface« vsebuje povezavo »Members«, ki navaja vse lastnosti in metode do katerih lahko preko vmesnika dostopamo.
- 2. Method (metoda / funkcija)
- 3. Example (primeri)
Ko preiskujete API Help datoteko bodite pozorni na sporočila »Obsolete. Superseded by ...«. To so zastarele metode, ki še vedno delujejo, vendar so bolj omejene in lahko pride tudi do nepričakovanih napak, ki so v novejših verzijah že odpravljene.