ociap.inc 482 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997
  1. {
  2. Automatically converted by H2Pas 1.0.0 from ociap.h
  3. The following command line parameters were used:
  4. -p
  5. -D
  6. -l
  7. jojo.so
  8. ociap.h
  9. }
  10. Type
  11. // Pboolean = ^boolean;
  12. // Ppdvoid = ^Pdvoid;
  13. PPub4 = ^Pub4;
  14. PPub2 = ^Pub2;
  15. size_t = ptrint;
  16. psize_t = ^ptrint;
  17. { PLda_Def = ^Lda_Def;
  18. PnzttBufferBlock = ^nzttBufferBlock;
  19. PnzttIdentity = ^nzttIdentity;
  20. PnzttIdentityDesc = ^nzttIdentityDesc;
  21. PnzttPersona = ^nzttPersona;
  22. PnzttPersonaDesc = ^nzttPersonaDesc;
  23. PnzttProtInfo = ^nzttProtInfo;
  24. Pnztttdufmt = ^nztttdufmt;
  25. PnzttWallet = ^nzttWallet;
  26. POCIAdmin = ^OCIAdmin;
  27. POCIAnyData = ^OCIAnyData;
  28. POCIAnyDataSet = ^OCIAnyDataSet;
  29. POCIAQAgent = ^OCIAQAgent;
  30. POCIAQDeqOptions = ^OCIAQDeqOptions;
  31. POCIAQEnqOptions = ^OCIAQEnqOptions;
  32. POCIAQLisMsgProps = ^OCIAQLisMsgProps;
  33. POCIAQListenOpts = ^OCIAQListenOpts;
  34. POCIAQMsgProperties = ^OCIAQMsgProperties;
  35. POCIAuthInfo = ^OCIAuthInfo;
  36. POCIBind = ^OCIBind;
  37. POCICPool = ^OCICPool;
  38. POCIDateTime = ^OCIDateTime;
  39. POCIDefine = ^OCIDefine;
  40. POCIDescribe = ^OCIDescribe;
  41. POCIEnv = ^OCIEnv;
  42. POCIError = ^OCIError;
  43. POCIEvent = ^OCIEvent;
  44. POCIFileObject = ^OCIFileObject;
  45. POCIFocbkStruct = ^OCIFocbkStruct;
  46. POCIInd = ^OCIInd;
  47. POCIInterval = ^OCIInterval;
  48. POCILobLocator = ^OCILobLocator;
  49. POCIMsg = ^OCIMsg;
  50. POCINumber = ^OCINumber;
  51. POCIPicklerFdo = ^OCIPicklerFdo;
  52. POCIPicklerImage = ^OCIPicklerImage;
  53. POCIPicklerTds = ^OCIPicklerTds;
  54. POCIPicklerTdsCtx = ^OCIPicklerTdsCtx;
  55. // POCIPicklerTdsElement = ^OCIPicklerTdsElement;
  56. POCIRaw = ^OCIRaw;
  57. POCIResult = ^OCIResult;
  58. POCIRowid = ^OCIRowid;
  59. POCISecurity = ^OCISecurity;
  60. POCIServer = ^OCIServer;
  61. POCISession = ^OCISession;
  62. POCISnapshot = ^OCISnapshot;
  63. POCISPool = ^OCISPool;
  64. POCIStmt = ^OCIStmt;
  65. POCISubscription = ^OCISubscription;
  66. POCISvcCtx = ^OCISvcCtx;
  67. POCIThreadHandle = ^OCIThreadHandle;
  68. POCIThreadId = ^OCIThreadId;
  69. POCIThreadKey = ^OCIThreadKey;
  70. POCIThreadMutex = ^OCIThreadMutex;
  71. POCITrans = ^OCITrans;
  72. POCIType = ^OCIType;
  73. POCITypeCode = ^OCITypeCode;
  74. POCIUcb = ^OCIUcb;
  75. POCIUserCallback = ^OCIUserCallback;
  76. // POCIWchar = ^OCIWchar;
  77. POraText = ^OraText;
  78. Poraub8 = ^oraub8;
  79. Psb1 = ^sb1;
  80. Psb2 = ^sb2;
  81. Psb4 = ^sb4;
  82. Psbig_ora = ^sbig_ora;
  83. Psize_t = ^size_t;
  84. Psword = ^sword;
  85. Ptext = ^text;
  86. Pub1 = ^ub1;
  87. Pub2 = ^ub2;
  88. Pub4 = ^ub4;
  89. Pubig_ora = ^ubig_ora;
  90. Puword = ^uword;
  91. }
  92. {$PACKRECORDS C}
  93. {
  94. * $Header: ociap.h 11-aug-2004.18:52:42 rvissapr Exp $
  95. }
  96. { Copyright (c) 1996, 2004, Oracle. All rights reserved. }
  97. { NOTE: See 'header_template.doc' in the 'doc' dve under the 'forms'
  98. directory for the header file template that includes instructions.
  99. }
  100. {
  101. NAME
  102. ociap.h - Oracle Call Interface - Ansi Prototypes
  103. DESCRIPTION
  104. <short description of component this file declares/defines>
  105. RELATED DOCUMENTS
  106. INSPECTION STATUS
  107. Inspection date:
  108. Inspection status:
  109. Estimated increasing cost defects per page:
  110. Rule sets:
  111. ACCEPTANCE REVIEW STATUS
  112. Review date:
  113. Review status:
  114. Reviewers:
  115. PUBLIC FUNCTION(S)
  116. <list of external functions declared/defined - with one-line descriptions>
  117. PRIVATE FUNCTION(S)
  118. <list of static functions defined in .c file - with one-line descriptions>
  119. EXAMPLES
  120. NOTES
  121. <other useful comments, qualifications, etc.>
  122. MODIFIED (MM/DD/YY)
  123. nbhatt 06/17/04 - merge conflicts
  124. nbhatt 05/24/04 - merge conflicts
  125. weiwang 05/06/04 - add OCIAQListen2
  126. rvissapr 06/21/04 - add OCIAppCtx API
  127. debanerj 05/17/04 - 13064: LOB array Read and Write
  128. aahluwal 06/02/04 - [OCI Events]: add OCIInitEventHandle
  129. nikeda 05/28/04 - grabtrans 'nikeda_oci_events_copy'
  130. nikeda 05/13/04 - [OCI Events] Rename HACBK->EVTCBK, HACTX->EVTCTX
  131. nikeda 05/10/04 - [OCI Events] code review changes
  132. aahluwal 04/09/04 - [OCI Events]: add OCIHAServerHandleGet
  133. nikeda 03/18/04 - [OCI Events] New Server Handle Callback
  134. dfrumkin 12/04/03 - Add OCIDBStartup, OCIDBShutdown
  135. jciminsk 12/12/03 - merge from RDBMS_MAIN_SOLARIS_031209
  136. sgollapu 06/26/03 - Change OCIPing prototype
  137. sgollapu 05/05/03 - Add OCIPing
  138. debanerj 01/16/03 - Bug 2753018: Lob Locator parameter for
  139. OCILobGetStorageLimit
  140. rpingte 05/06/04 - add OCIClientVersion
  141. debanerj 08/26/03 - 6003: Lob interface changes
  142. sgollapu 06/23/03 - Add OCIPing
  143. debanerj 01/16/03 - Bug 2753018: Lob Locator parameter for
  144. OCILobGetStorageLimit
  145. tkeefe 02/17/03 - bug-2773794: Add new interface for setting Kerb attrs
  146. ataracha 01/03/03 - Move OCIXMLType functions to ocixml.h
  147. akatti 11/28/02 - [2521361]:add OCIRowidToChar prototype
  148. chliang 10/23/02 - add OCIFetchRowCallback
  149. cparampa 10/13/02 - Fix the prototype of OCIAQListen(ansi prototype)
  150. chliang 10/12/02 - add OCIBindRowCallback
  151. debanerj 09/30/02 - Unlimited size LOB 6003
  152. thoang 09/25/02 - Add csid to XMLType create functions
  153. thoang 04/19/02 - Add OCIXMLTypeGetNS
  154. aahluwal 08/09/02 - adding OCIAQDeqArray
  155. aahluwal 06/03/02 - bug 2360115
  156. skabraha 04/16/02 - fix compiler warnings
  157. sichandr 02/12/02 - fix OCIXMLTypeExists
  158. gayyappa 02/01/02 - fix 2210776 : change Dom to DOM
  159. sichandr 10/24/01 - OCISvcCtx for XMLType create routines
  160. schandir 09/14/01 - Add prototypes for Stmt Caching
  161. abande 09/04/01 - Add Prototypes for Session Pooling Methods
  162. stakeda 09/12/01 - add OCINlsCharSetConvert
  163. whe 08/28/01 - add OCIEnvNlsCreate
  164. wzhang 08/22/01 - Add OCINlsCharSetNameToId.
  165. whe 10/05/01 - add prototype for OCIXMLType functions
  166. mdmehta 04/06/01 - Bug 1683763, OCIDateTimeToText: buf_size to ub4*
  167. schandir 12/12/00 - modify the ociconnectionpoolcreate() interface.
  168. porangas 12/04/00 - Forward merge bug#974710 to 9i
  169. rpingte 11/29/00 - Fix bug# 1485795.
  170. gtarora 11/30/00 - fix comment for OCILobIsTemporary
  171. akatti 11/07/00 - [1198379]:add OCIRowidToChar
  172. bpalaval 10/15/00 - Forward merge 892654.
  173. kmohan 09/18/00 - add OCILogon2
  174. etucker 07/28/00 - add OCIIntervalFromTZ
  175. vjayaram 07/18/00 - add connection pooling changes
  176. etucker 07/13/00 - add dls apis for oci
  177. hmasaki 07/05/00 - fix 1230846: forward merge into 8.2
  178. mbastawa 06/05/00 - add OCIStmtFetch2
  179. rxgovind 06/07/00 - update OCIAnyData interfaces
  180. rxgovind 05/04/00 - add OCIAnyDataSet interfaces
  181. rkasamse 05/01/00 - remove attrno from OCIAnyDataAttrGet
  182. rkasamse 03/13/00 - add prototype s for OCCIAnyData
  183. slari 09/01/99 - remove OCIEnvCallback
  184. slari 08/23/99 - add OCIUcb in user callback functions
  185. dsaha 07/07/99 - Add OCIFEnvCreate for forms
  186. vyanaman 06/21/99 - Change OCI DateTime/Interval APIs.
  187. esoyleme 07/01/99 - expose MTS performance enhancements
  188. whe 06/14/99 - bug727872:add CONST to match definitions
  189. kkarun 02/23/99 - Fix OCIDateTime APIs
  190. jiyang 12/07/98 - Add comments for OCI_NLS_DUAL_CURRENCY
  191. aroy 12/01/98 - add OCIEnvCreate
  192. slari 11/23/98 - use ORASTDARG
  193. slari 11/21/98 - replace ellipsis by arglist in OCIUserCallback
  194. thchang 10/20/98 - correct comment on OCILobCreateTemporary
  195. slari 09/08/98 - allow envh to receive error info also in CallbackReg/
  196. kkarun 09/02/98 - Change const to CONST
  197. aroy 08/04/98 - add OCITerminate calls
  198. nramakri 06/25/98 - remove CONST from some OCIPickler APIs
  199. jiyang 06/22/98 - Fix a lint error
  200. nmallava 06/08/98 - ociistemporary -> envhp
  201. jhasenbe 05/27/98 - Remove definitions for U-Calls (Unicode)
  202. nmallava 05/18/98 - add comments
  203. sgollapu 05/19/98 - Change text to OraText
  204. aroy 04/20/98 - merge forward 8.0.5 -> 8.1.3
  205. nbhatt 05/14/98 - aq listen call
  206. lchidamb 03/02/98 - Client Notification prototypes
  207. vyanaman 04/19/98 - System Timestamp
  208. kkarun 04/17/98 - Add more Interval functions
  209. vyanaman 04/17/98 - Fix min (proc error)
  210. vyanaman 04/16/98 - Add get/set TZ
  211. kkarun 04/13/98 - Add Datetime prototypes
  212. rkasamse 04/13/98 - change OCIEnv* to dvoid* for context/memory cart serv
  213. rkasamse 04/15/98 - chage pickler cart interface
  214. slari 03/20/98 - change proto of OCIUserCallback
  215. slari 02/17/98 - add OCIUserCallback
  216. jiyang 04/02/98 - Accept both env and user handles for NLS
  217. rkasamse 03/20/98 - remove prototypes for OCIMemoryDuration* functions.
  218. tsaulys 03/20/98 - use environment or session handle
  219. nmallava 04/09/98 - OCILobLocatorAssign
  220. nmallava 04/07/98 - lobgetchunksize and writeappend apis
  221. jhasenbe 04/06/98 - Add new interfaces for Unicode support
  222. nmallava 03/17/98 - add interfaces
  223. nmallava 03/16/98 - add open/close apis
  224. nmallava 03/10/98 - add temporary lobs apis
  225. sgollapu 07/10/97 - Add OCIReset
  226. sgollapu 02/09/98 - OCI non-blocking
  227. nramakri 01/16/98 - remove #ifdef NEVER clause for OCIExtract
  228. rmurthy 01/08/98 - OCIContextGenerateKey: change ub1 to ub4
  229. ewaugh 12/18/97 - Turn type wrappers into functions.
  230. skabraha 12/02/97 - adding OCIFile functions
  231. rhwu 12/02/97 - add OCI Thread
  232. nramakri 12/15/97 - move to core4
  233. nramakri 12/11/97 - modify OCIExtract prototype
  234. ewaugh 12/10/97 - add OCIFormat prototypes
  235. nmallava 12/17/97 - Add ilob open and close apis
  236. rkasamse 12/03/97 - Change some of the function names for pickler cartrid
  237. nramakri 11/12/97 - add OCIExtract prototypes
  238. rkasamse 11/21/97 - add prototypes for memory cartridge services and cont
  239. rkasamse 11/03/97 - Add pickler cartridge interfaces.
  240. jiyang 11/11/97 - Add NLS service for cartridge
  241. tanguyen 08/19/97 -
  242. cxcheng 07/30/97 - replace OCISvcCtx with OCISvcCtx
  243. schandra 06/25/97 - AQ OCI interface
  244. bnainani 07/21/97 - add prototypes for Oracle XA extensions
  245. esoyleme 05/13/97 - move failover callback prototype
  246. skmishra 05/06/97 - stdc compiler fixes
  247. skmishra 04/24/97 - C++ Compatibility changes
  248. skotsovo 04/21/97 - make lob parameter names consistent
  249. rwhitman 04/16/97 - Fix LOB prototypes - Olint OCI 8.0.3
  250. ramkrish 04/15/97 - Add free flag to OCILobFlushBuffer
  251. dchatter 04/10/97 - add nzt.h inclusion
  252. cxcheng 04/09/97 - change objnamp from CONST text* to dvoid*
  253. cxcheng 04/08/97 - fix prototype of OCIDescribeAny()
  254. skotsovo 03/31/97 - remove OCILobLocatorSize
  255. skotsovo 03/27/97 - add OCILobLoadFromFile
  256. bcchang 02/18/97 - Fix syntax error
  257. dchatter 01/13/97 - fix comments on LOB calls
  258. aroy 01/10/97 - remove ocilobfilecreate delete
  259. sgollapu 12/27/96 - Correct OCILogon prototype
  260. dchatter 01/04/97 - comments to describe the functions
  261. sgollapu 11/25/96 - Change OCILobFileIsExistent
  262. schandra 11/18/96 - Remove xa.h include
  263. sgollapu 11/09/96 - Change prototype of OCIDescribeAny
  264. dchatter 10/31/96 - delete CONST from lob write cb fn
  265. dchatter 10/30/96 - more changes
  266. dchatter 10/26/96 - lob/file long name corrections
  267. slari 10/16/96 - delete unused calls
  268. rwessman 10/29/96 - Fixed OCISecurityGetIdentity prototype
  269. bcchang 10/25/96 - Fix syntax error
  270. sgollapu 10/22/96 - Add OCILogon and OCILogoff
  271. rwessman 10/16/96 - Added cryptographic and digital signature functions
  272. sgollapu 10/10/96 - Add ocibdp and ocibdn
  273. rxgovind 10/07/96 - add oci file calls
  274. skotsovo 10/01/96 - move orl lob fnts to oci
  275. skotsovo 09/20/96 - in OCILobGetLength(), remove the 'isnull' parameter.
  276. aroy 08/29/96 - change prototype for Nchar Lob support
  277. dchatter 08/21/96 - OCIResultSetToStmt prototype change
  278. sthakur 08/14/96 - add OCIParamSet
  279. schandra 07/26/96 - TX OCI return values - sb4->sword
  280. aroy 07/17/96 - terminology change: OCILobLocator => OCILobLocator
  281. dchatter 07/01/96 - create ANSI prototypes
  282. dchatter 07/01/96 - Creation
  283. }
  284. {$ifndef OCIAP_ORACLE}
  285. {$define OCIAP_ORACLE}
  286. {$ifndef ORASTDARG}
  287. { $include <stdarg.h>}
  288. {$define ORASTDARG}
  289. {$endif}
  290. {$ifndef OCIDFN}
  291. { $include <ocidfn.h>}
  292. {$endif}
  293. {$include nzt.inc}
  294. { NZT_ORACLE }
  295. {$ifndef ORT_ORACLE}
  296. { $include <ort.h>}
  297. {$endif}
  298. {---------------------------------------------------------------------------
  299. PUBLIC TYPES AND CONSTANTS
  300. --------------------------------------------------------------------------- }
  301. {---------------------------------------------------------------------------
  302. PRIVATE TYPES AND CONSTANTS
  303. --------------------------------------------------------------------------- }
  304. {---------------------------------------------------------------------------
  305. PUBLIC FUNCTIONS
  306. --------------------------------------------------------------------------- }
  307. {****************************************************************************
  308. DESCRIPTION
  309. ******************************************************************************
  310. Note: the descriptions of the functions are alphabetically arranged. Please
  311. maintain the arrangement when adding a new function description. The actual
  312. prototypes are below this comment section and donot follow any alphabetical
  313. ordering.
  314. --------------------------------OCIAttrGet------------------------------------
  315. OCIAttrGet()
  316. Name
  317. OCI Attribute Get
  318. Purpose
  319. This call is used to get a particular attribute of a handle.
  320. Syntax
  321. sword OCIAttrGet ( CONST dvoid *trgthndlp,
  322. ub4 trghndltyp,
  323. dvoid *attributep,
  324. ub4 *sizep,
  325. ub4 attrtype,
  326. OCIError *errhp );
  327. Comments
  328. This call is used to get a particular attribute of a handle.
  329. See Appendix B, "Handle Attributes", for a list of handle types and their
  330. readable attributes.
  331. Parameters
  332. trgthndlp (IN) - is the pointer to a handle type.
  333. trghndltyp (IN) - is the handle type.
  334. attributep (OUT) - is a pointer to the storage for an attribute value. The
  335. attribute value is filled in.
  336. sizep (OUT) - is the size of the attribute value.
  337. This can be passed in as NULL for most parameters as the size is well known.
  338. For text* parameters, a pointer to a ub4 must be passed in to get the length
  339. of the string.
  340. attrtype (IN) - is the type of attribute.
  341. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  342. diagnostic information in the event of an error.
  343. Related Functions
  344. OCIAttrSet()
  345. --------------------------------OCIAttrSet------------------------------------
  346. OCIAttrSet()
  347. Name
  348. OCI Attribute Set
  349. Purpose
  350. This call is used to set a particular attribute of a handle or a descriptor.
  351. Syntax
  352. sword OCIAttrSet ( dvoid *trgthndlp,
  353. ub4 trghndltyp,
  354. dvoid *attributep,
  355. ub4 size,
  356. ub4 attrtype,
  357. OCIError *errhp );
  358. Comments
  359. This call is used to set a particular attribute of a handle or a descriptor.
  360. See Appendix B for a list of handle types and their writeable attributes.
  361. Parameters
  362. trghndlp (IN/OUT) - the pointer to a handle type whose attribute gets
  363. modified.
  364. trghndltyp (IN/OUT) - is the handle type.
  365. attributep (IN) - a pointer to an attribute value.
  366. The attribute value is copied into the target handle. If the attribute value
  367. is a pointer, then only the pointer is copied, not the contents of the pointer.
  368. size (IN) - is the size of an attribute value. This can be passed in as 0 for
  369. most attributes as the size is already known by the OCI library. For text*
  370. attributes, a ub4 must be passed in set to the length of the string.
  371. attrtype (IN) - the type of attribute being set.
  372. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  373. diagnostic information in the event of an error.
  374. Related Functions
  375. OCIAttrGet()
  376. --------------------------------OCIBindArrayOfStruct--------------------------
  377. OCIBindArrayOfStruct()
  378. Name
  379. OCI Bind for Array of Structures
  380. Purpose
  381. This call sets up the skip parameters for a static array bind.
  382. Syntax
  383. sword OCIBindArrayOfStruct ( OCIBind *bindp,
  384. OCIError *errhp,
  385. ub4 pvskip,
  386. ub4 indskip,
  387. ub4 alskip,
  388. ub4 rcskip );
  389. Comments
  390. This call sets up the skip parameters necessary for a static array bind.
  391. This call follows a call to OCIBindByName() or OCIBindByPos(). The bind
  392. handle returned by that initial bind call is used as a parameter for the
  393. OCIBindArrayOfStruct() call.
  394. For information about skip parameters, see the section "Arrays of Structures"
  395. on page 4-16.
  396. Parameters
  397. bindp (IN) - the handle to a bind structure.
  398. errhp (IN) - an error handle which can be passed to OCIErrorGet() for
  399. diagnostic information in the event of an error.
  400. pvskip (IN) - skip parameter for the next data value.
  401. indskip (IN) - skip parameter for the next indicator value or structure.
  402. alskip (IN) - skip parameter for the next actual length value.
  403. rcskip (IN) - skip parameter for the next column-level return code value.
  404. Related Functions
  405. OCIAttrGet()
  406. --------------------------------OCIBindByName---------------------------------
  407. OCIBindByName()
  408. Name
  409. OCI Bind by Name
  410. Purpose
  411. Creates an association between a program variable and a placeholder in a SQL
  412. statement or PL/SQL block.
  413. Syntax
  414. sword OCIBindByName (
  415. OCIStmt *stmtp,
  416. OCIBind **bindp,
  417. OCIError *errhp,
  418. CONST OraText *placeholder,
  419. sb4 placeh_len,
  420. dvoid *valuep,
  421. sb4 value_sz,
  422. ub2 dty,
  423. dvoid *indp,
  424. ub2 *alenp,
  425. ub2 *rcodep,
  426. ub4 maxarr_len,
  427. ub4 *curelep,
  428. ub4 mode );
  429. Description
  430. This call is used to perform a basic bind operation. The bind creates an
  431. association between the address of a program variable and a placeholder in a
  432. SQL statement or PL/SQL block. The bind call also specifies the type of data
  433. which is being bound, and may also indicate the method by which data will be
  434. provided at runtime.
  435. This function also implicitly allocates the bind handle indicated by the bindp
  436. parameter.
  437. Data in an OCI application can be bound to placeholders statically or
  438. dynamically. Binding is static when all the IN bind data and the OUT bind
  439. buffers are well-defined just before the execute. Binding is dynamic when the
  440. IN bind data and the OUT bind buffers are provided by the application on
  441. demand at execute time to the client library. Dynamic binding is indicated by
  442. setting the mode parameter of this call to OCI_DATA_AT_EXEC.
  443. Related Functions: For more information about dynamic binding, see
  444. the section "Runtime Data Allocation and Piecewise Operations" on
  445. page 5-16.
  446. Both OCIBindByName() and OCIBindByPos() take as a parameter a bind handle,
  447. which is implicitly allocated by the bind call A separate bind handle is
  448. allocated for each placeholder the application is binding.
  449. Additional bind calls may be required to specify particular attributes
  450. necessary when binding certain data types or handling input data in certain
  451. ways:
  452. If arrays of structures are being utilized, OCIBindArrayOfStruct() must
  453. be called to set up the necessary skip parameters.
  454. If data is being provided dynamically at runtime, and the application
  455. will be using user-defined callback functions, OCIBindDynamic() must
  456. be called to register the callbacks.
  457. If a named data type is being bound, OCIBindObject() must be called to
  458. specify additional necessary information.
  459. Parameters
  460. stmth (IN/OUT) - the statement handle to the SQL or PL/SQL statement
  461. being processed.
  462. bindp (IN/OUT) - a pointer to a pointer to a bind handle which is implicitly
  463. allocated by this call. The bind handle maintains all the bind information
  464. for this particular input value. The handle is feed implicitly when the
  465. statement handle is deallocated.
  466. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  467. diagnostic information in the event of an error.
  468. placeholder (IN) - the placeholder attributes are specified by name if
  469. ocibindn() is being called.
  470. placeh_len (IN) - the length of the placeholder name specified in placeholder.
  471. valuep (IN/OUT) - a pointer to a data value or an array of data values of the
  472. type specified in the dty parameter. An array of data values can be specified
  473. for mapping into a PL/SQL table or for providing data for SQL multiple-row
  474. operations. When an array of bind values is provided, this is called an array
  475. bind in OCI terms. Additional attributes of the array bind (not bind to a
  476. column of ARRAY type) are set up in OCIBindArrayOfStruct() call.
  477. For a REF, named data type bind, the valuep parameter is used only for IN
  478. bind data. The pointers to OUT buffers are set in the pgvpp parameter
  479. initialized by OCIBindObject(). For named data type and REF binds, the bind
  480. values are unpickled into the Object Cache. The OCI object navigational calls
  481. can then be used to navigate the objects and the refs in the Object Cache.
  482. If the OCI_DATA_AT_EXEC mode is specified in the mode parameter, valuep
  483. is ignored for all data types. OCIBindArrayOfStruct() cannot be used and
  484. OCIBindDynamic() must be invoked to provide callback functions if desired.
  485. value_sz (IN) - the size of a data value. In the case of an array bind, this is
  486. the maximum size of any element possible with the actual sizes being specified
  487. in the alenp parameter.
  488. If the OCI_DATA_AT_EXEC mode is specified, valuesz defines the maximum
  489. size of the data that can be ever provided at runtime for data types other than
  490. named data types or REFs.
  491. dty (IN) - the data type of the value(s) being bound. Named data types
  492. (SQLT_NTY) and REFs (SQLT_REF) are valid only if the application has been
  493. initialized in object mode. For named data types, or REFs, additional calls
  494. must be made with the bind handle to set up the datatype-specific attributes.
  495. indp (IN/OUT) - pointer to an indicator variable or array. For scalar data
  496. types, this is a pointer to sb2 or an array of sb2s. For named data types,
  497. this pointer is ignored and the actual pointer to the indicator structure or
  498. an array of indicator structures is initialized by OCIBindObject().
  499. Ignored for dynamic binds.
  500. See the section "Indicator Variables" on page 2-43 for more information about
  501. indicator variables.
  502. alenp (IN/OUT) - pointer to array of actual lengths of array elements. Each
  503. element in alenp is the length of the data in the corresponding element in the
  504. bind value array before and after the execute. This parameter is ignored for
  505. dynamic binds.
  506. rcodep (OUT) - pointer to array of column level return codes. This parameter
  507. is ignored for dynamic binds.
  508. maxarr_len (IN) - the maximum possible number of elements of type dty in a
  509. PL/SQL binds. This parameter is not required for non-PL/SQL binds. If
  510. maxarr_len is non-zero, then either OCIBindDynamic() or
  511. OCIBindArrayOfStruct() can be invoked to set up additional bind attributes.
  512. curelep(IN/OUT) - a pointer to the actual number of elements. This parameter
  513. is only required for PL/SQL binds.
  514. mode (IN) - the valid modes for this parameter are:
  515. OCI_DEFAULT. This is default mode.
  516. OCI_DATA_AT_EXEC. When this mode is selected, the value_sz
  517. parameter defines the maximum size of the data that can be ever
  518. provided at runtime. The application must be ready to provide the OCI
  519. library runtime IN data buffers at any time and any number of times.
  520. Runtime data is provided in one of the two ways:
  521. callbacks using a user-defined function which must be registered
  522. with a subsequent call to OCIBindDynamic().
  523. a polling mechanism using calls supplied by the OCI. This mode
  524. is assumed if no callbacks are defined.
  525. For more information about using the OCI_DATA_AT_EXEC mode, see
  526. the section "Runtime Data Allocation and Piecewise Operations" on
  527. page 5-16.
  528. When the allocated buffers are not required any more, they should be
  529. freed by the client.
  530. Related Functions
  531. OCIBindDynamic(), OCIBindObject(), OCIBindArrayOfStruct(), OCIAttrGet()
  532. -------------------------------OCIBindByPos-----------------------------------
  533. OCIBindByPos()
  534. Name
  535. OCI Bind by Position
  536. Purpose
  537. Creates an association between a program variable and a placeholder in a SQL
  538. statement or PL/SQL block.
  539. Syntax
  540. sword OCIBindByPos (
  541. OCIStmt *stmtp,
  542. OCIBind **bindp,
  543. OCIError *errhp,
  544. ub4 position,
  545. dvoid *valuep,
  546. sb4 value_sz,
  547. ub2 dty,
  548. dvoid *indp,
  549. ub2 *alenp,
  550. ub2 *rcodep,
  551. ub4 maxarr_len,
  552. ub4 *curelep,
  553. ub4 mode);
  554. Description
  555. This call is used to perform a basic bind operation. The bind creates an
  556. association between the address of a program variable and a placeholder in a
  557. SQL statement or PL/SQL block. The bind call also specifies the type of data
  558. which is being bound, and may also indicate the method by which data will be
  559. provided at runtime.
  560. This function also implicitly allocates the bind handle indicated by the bindp
  561. parameter.
  562. Data in an OCI application can be bound to placeholders statically or
  563. dynamically. Binding is static when all the IN bind data and the OUT bind
  564. buffers are well-defined just before the execute. Binding is dynamic when the
  565. IN bind data and the OUT bind buffers are provided by the application on
  566. demand at execute time to the client library. Dynamic binding is indicated by
  567. setting the mode parameter of this call to OCI_DATA_AT_EXEC.
  568. Related Functions: For more information about dynamic binding, see
  569. the section "Runtime Data Allocation and Piecewise Operations" on
  570. page 5-16
  571. Both OCIBindByName() and OCIBindByPos() take as a parameter a bind handle,
  572. which is implicitly allocated by the bind call A separate bind handle is
  573. allocated for each placeholder the application is binding.
  574. Additional bind calls may be required to specify particular attributes
  575. necessary when binding certain data types or handling input data in certain
  576. ways:
  577. If arrays of structures are being utilized, OCIBindArrayOfStruct() must
  578. be called to set up the necessary skip parameters.
  579. If data is being provided dynamically at runtime, and the application
  580. will be using user-defined callback functions, OCIBindDynamic() must
  581. be called to register the callbacks.
  582. If a named data type is being bound, OCIBindObject() must be called to
  583. specify additional necessary information.
  584. Parameters
  585. stmth (IN/OUT) - the statement handle to the SQL or PL/SQL statement
  586. being processed.
  587. bindp (IN/OUT) - a pointer to a pointer to a bind handle which is implicitly
  588. allocated by this call. The bind handle maintains all the bind information
  589. for this particular input value. The handle is feed implicitly when the
  590. statement handle is deallocated.
  591. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  592. diagnostic information in the event of an error.
  593. position (IN) - the placeholder attributes are specified by position if
  594. ocibindp() is being called.
  595. valuep (IN/OUT) - a pointer to a data value or an array of data values of the
  596. type specified in the dty parameter. An array of data values can be specified
  597. for mapping into a PL/SQL table or for providing data for SQL multiple-row
  598. operations. When an array of bind values is provided, this is called an array
  599. bind in OCI terms. Additional attributes of the array bind (not bind to a
  600. column of ARRAY type) are set up in OCIBindArrayOfStruct() call.
  601. For a REF, named data type bind, the valuep parameter is used only for IN
  602. bind data. The pointers to OUT buffers are set in the pgvpp parameter
  603. initialized by OCIBindObject(). For named data type and REF binds, the bind
  604. values are unpickled into the Object Cache. The OCI object navigational calls
  605. can then be used to navigate the objects and the refs in the Object Cache.
  606. If the OCI_DATA_AT_EXEC mode is specified in the mode parameter, valuep
  607. is ignored for all data types. OCIBindArrayOfStruct() cannot be used and
  608. OCIBindDynamic() must be invoked to provide callback functions if desired.
  609. value_sz (IN) - the size of a data value. In the case of an array bind, this is
  610. the maximum size of any element possible with the actual sizes being specified
  611. in the alenp parameter.
  612. If the OCI_DATA_AT_EXEC mode is specified, valuesz defines the maximum
  613. size of the data that can be ever provided at runtime for data types other than
  614. named data types or REFs.
  615. dty (IN) - the data type of the value(s) being bound. Named data types
  616. (SQLT_NTY) and REFs (SQLT_REF) are valid only if the application has been
  617. initialized in object mode. For named data types, or REFs, additional calls
  618. must be made with the bind handle to set up the datatype-specific attributes.
  619. indp (IN/OUT) - pointer to an indicator variable or array. For scalar data
  620. types, this is a pointer to sb2 or an array of sb2s. For named data types,
  621. this pointer is ignored and the actual pointer to the indicator structure or
  622. an array of indicator structures is initialized by OCIBindObject(). Ignored
  623. for dynamic binds.
  624. See the section "Indicator Variables" on page 2-43 for more information about
  625. indicator variables.
  626. alenp (IN/OUT) - pointer to array of actual lengths of array elements. Each
  627. element in alenp is the length of the data in the corresponding element in the
  628. bind value array before and after the execute. This parameter is ignored for
  629. dynamic binds.
  630. rcodep (OUT) - pointer to array of column level return codes. This parameter
  631. is ignored for dynamic binds.
  632. maxarr_len (IN) - the maximum possible number of elements of type dty in a
  633. PL/SQL binds. This parameter is not required for non-PL/SQL binds. If
  634. maxarr_len is non-zero, then either OCIBindDynamic() or
  635. OCIBindArrayOfStruct() can be invoked to set up additional bind attributes.
  636. curelep(IN/OUT) - a pointer to the actual number of elements. This parameter
  637. is only required for PL/SQL binds.
  638. mode (IN) - the valid modes for this parameter are:
  639. OCI_DEFAULT. This is default mode.
  640. OCI_DATA_AT_EXEC. When this mode is selected, the value_sz
  641. parameter defines the maximum size of the data that can be ever
  642. provided at runtime. The application must be ready to provide the OCI
  643. library runtime IN data buffers at any time and any number of times.
  644. Runtime data is provided in one of the two ways:
  645. callbacks using a user-defined function which must be registered
  646. with a subsequent call to OCIBindDynamic() .
  647. a polling mechanism using calls supplied by the OCI. This mode
  648. is assumed if no callbacks are defined.
  649. For more information about using the OCI_DATA_AT_EXEC mode, see
  650. the section "Runtime Data Allocation and Piecewise Operations" on
  651. page 5-16.
  652. When the allocated buffers are not required any more, they should be
  653. freed by the client.
  654. Related Functions
  655. OCIBindDynamic(), OCIBindObject(), OCIBindArrayOfStruct(), OCIAttrGet()
  656. -------------------------------OCIBindDynamic---------------------------------
  657. OCIBindDynamic()
  658. Name
  659. OCI Bind Dynamic Attributes
  660. Purpose
  661. This call is used to register user callbacks for dynamic data allocation.
  662. Syntax
  663. sword OCIBindDynamic( OCIBind *bindp,
  664. OCIError *errhp,
  665. dvoid *ictxp,
  666. OCICallbackInBind (icbfp)(
  667. dvoid *ictxp,
  668. OCIBind *bindp,
  669. ub4 iter,
  670. ub4 index,
  671. dvoid **bufpp,
  672. ub4 *alenp,
  673. ub1 *piecep,
  674. dvoid **indp ),
  675. dvoid *octxp,
  676. OCICallbackOutBind (ocbfp)(
  677. dvoid *octxp,
  678. OCIBind *bindp,
  679. ub4 iter,
  680. ub4 index,
  681. dvoid **bufp,
  682. ub4 **alenpp,
  683. ub1 *piecep,
  684. dvoid **indpp,
  685. ub2 **rcodepp) );
  686. Comments
  687. This call is used to register user-defined callback functions for providing
  688. data for an UPDATE or INSERT if OCI_DATA_AT_EXEC mode was specified in a
  689. previous call to OCIBindByName() or OCIBindByPos().
  690. The callback function pointers must return OCI_CONTINUE if it the call is
  691. successful. Any return code other than OCI_CONTINUE signals that the client
  692. wishes to abort processing immediately.
  693. For more information about the OCI_DATA_AT_EXEC mode, see the section
  694. "Runtime Data Allocation and Piecewise Operations" on page 5-16.
  695. Parameters
  696. bindp (IN/OUT) - a bind handle returned by a call to OCIBindByName() or
  697. OCIBindByPos().
  698. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  699. diagnostic information in the event of an error.
  700. ictxp (IN) - the context pointer required by the call back function icbfp.
  701. icbfp (IN) - the callback function which returns a pointer to the IN bind
  702. value or piece at run time. The callback takes in the following parameters.
  703. ictxp (IN/OUT) - the context pointer for this callback function.
  704. bindp (IN) - the bind handle passed in to uniquely identify this bind
  705. variable.
  706. iter (IN) - 1-based execute iteration value.
  707. index (IN) - index of the current array, for an array bind. 1 based not
  708. greater than curele parameter of the bind call.
  709. index (IN) - index of the current array, for an array bind. This parameter
  710. is 1-based, and may not be greater than curele parameter of the bind call.
  711. bufpp (OUT) - the pointer to the buffer.
  712. piecep (OUT) - which piece of the bind value. This can be one of the
  713. following values - OCI_ONE_PIECE, OCI_FIRST_PIECE,
  714. OCI_NEXT_PIECE and OCI_LAST_PIECE.
  715. indp (OUT) - contains the indicator value. This is apointer to either an
  716. sb2 value or a pointer to an indicator structure for binding named data
  717. types.
  718. indszp (OUT) - contains the indicator value size. A pointer containing
  719. the size of either an sb2 or an indicator structure pointer.
  720. octxp (IN) - the context pointer required by the callback function ocbfp.
  721. ocbfp (IN) - the callback function which returns a pointer to the OUT bind
  722. value or piece at run time. The callback takes in the following parameters.
  723. octxp (IN/OUT) - the context pointer for this call back function.
  724. bindp (IN) - the bind handle passed in to uniquely identify this bind
  725. variable.
  726. iter (IN) - 1-based execute iteration value.
  727. index (IN) - index of the current array, for an array bind. This parameter
  728. is 1-based, and must not be greater than curele parameter of the bind call.
  729. bufpp (OUT) - a pointer to a buffer to write the bind value/piece.
  730. buflp (OUT) - returns the buffer size.
  731. alenpp (OUT) - a pointer to a storage for OCI to fill in the size of the bind
  732. value/piece after it has been read.
  733. piecep (IN/OUT) - which piece of the bind value. It will be set by the
  734. library to be one of the following values - OCI_ONE_PIECE or
  735. OCI_NEXT_PIECE. The callback function can leave it unchanged or set
  736. it to OCI_FIRST_PIECE or OCI_LAST_PIECE. By default -
  737. OCI_ONE_PIECE.
  738. indpp (OUT) - returns a pointer to contain the indicator value which
  739. either an sb2 value or a pointer to an indicator structure for named data
  740. types.
  741. indszpp (OUT) - returns a pointer to return the size of the indicator
  742. value which is either size of an sb2 or size of an indicator structure.
  743. rcodepp (OUT) - returns a pointer to contains the return code.
  744. Related Functions
  745. OCIAttrGet()
  746. ---------------------------------OCIBindObject--------------------------------
  747. OCIBindObject()
  748. Name
  749. OCI Bind Object
  750. Purpose
  751. This function sets up additional attributes which are required for a named
  752. data type (object) bind.
  753. Syntax
  754. sword OCIBindObject ( OCIBind *bindp,
  755. OCIError *errhp,
  756. CONST OCIType *type,
  757. dvoid **pgvpp,
  758. ub4 *pvszsp,
  759. dvoid **indpp,
  760. ub4 *indszp, );
  761. Comments
  762. This function sets up additional attributes which binding a named data type
  763. or a REF. An error will be returned if this function is called when the OCI
  764. environment has been initialized in non-object mode.
  765. This call takes as a paramter a type descriptor object (TDO) of datatype
  766. OCIType for the named data type being defined. The TDO can be retrieved
  767. with a call to OCITypeByName().
  768. If the OCI_DATA_AT_EXEC mode was specified in ocibindn() or ocibindp(), the
  769. pointers to the IN buffers are obtained either using the callback icbfp
  770. registered in the OCIBindDynamic() call or by the OCIStmtSetPieceInfo() call.
  771. The buffers are dynamically allocated for the OUT data and the pointers to
  772. these buffers are returned either by calling ocbfp() registered by the
  773. OCIBindDynamic() or by setting the pointer to the buffer in the buffer passed
  774. in by OCIStmtSetPieceInfo() called when OCIStmtExecute() returned
  775. OCI_NEED_DATA. The memory of these client library- allocated buffers must be
  776. freed when not in use anymore by using the OCIObjectFreee() call.
  777. Parameters
  778. bindp ( IN/OUT) - the bind handle returned by the call to OCIBindByName()
  779. or OCIBindByPos().
  780. errhp ( IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  781. diagnostic information in the event of an error.
  782. type ( IN) - points to the TDO which describes the type of the program
  783. variable being bound. Retrieved by calling OCITypeByName().
  784. pgvpp ( IN/OUT) - points to a pointer to the program variable buffer. For an
  785. array, pgvpp points to an array of pointers. When the bind variable is also an
  786. OUT variable, the OUT Named Data Type value or REF is allocated
  787. (unpickled) in the Object Cache, and a pointer to the value or REF is returned,
  788. At the end of execute, when all OUT values have been received, pgvpp points
  789. to an array of pointer(s) to these newly allocated named data types in the
  790. object cache.
  791. pgvpp is ignored if the OCI_DATA_AT_EXEC mode is set. Then the Named
  792. Data Type buffers are requested at runtime. For static array binds, skip
  793. factors may be specified using the OCIBindArrayOfStruct() call. The skip
  794. factors are used to compute the address of the next pointer to the value, the
  795. indicator structure and their sizes.
  796. pvszsp ( IN/OUT) - points to the size of the program variable. The size of the
  797. named data type is not required on input. For an array, pvszsp is an array of
  798. ub4s. On return, for OUT bind variables, this points to size(s) of the Named
  799. Data Types and REFs received. pvszsp is ignored if the OCI_DATA_AT_EXEC
  800. mode is set. Then the size of the buffer is taken at runtime.
  801. indpp ( IN/OUT) - points to a pointer to the program variable buffer
  802. containing the parallel indicator structure. For an array, points to an array
  803. of pointers. When the bind variable is also an OUT bind variable, memory is
  804. allocated in the object cache, to store the unpickled OUT indicator values. At
  805. the end of the execute when all OUT values have been received, indpp points
  806. to the pointer(s) to these newly allocated indicator structure(s).
  807. indpp is ignored if the OCI_DATA_AT_EXEC mode is set. Then the indicator
  808. is requested at runtime.
  809. indszp ( IN/OUT) - points to the size of the IN indicator structure program
  810. variable. For an array, it is an array of sb2s. On return for OUT bind
  811. variables, this points to size(s) of the received OUT indicator structures.
  812. indszp is ignored if the OCI_DATA_AT_EXEC mode is set. Then the indicator
  813. size is requested at runtime.
  814. Related Functions
  815. OCIAttrGet()
  816. ----------------------------------OCIBreak------------------------------------
  817. OCIBreak()
  818. Name
  819. OCI Break
  820. Purpose
  821. This call performs an immediate (asynchronous) abort of any currently
  822. executing OCI function that is associated with a server .
  823. Syntax
  824. sword OCIBreak ( dvoid *hndlp,
  825. OCIError *errhp);
  826. Comments
  827. This call performs an immediate (asynchronous) abort of any currently
  828. executing OCI function that is associated with a server. It is normally used
  829. to stop a long-running OCI call being processed on the server.
  830. This call can take either the service context handle or the server context
  831. handle as a parameter to identify the function to be aborted.
  832. Parameters
  833. hndlp (IN) - the service context handle or the server context handle.
  834. errhp (IN) - an error handle which can be passed to OCIErrorGet() for
  835. diagnostic information in the event of an error.
  836. Related Functions
  837. -----------------------------OCIConnectionPoolCreate --------------------------
  838. Name:
  839. OCIConnectionPoolCreate
  840. Purpose:
  841. Creates the connections in the pool
  842. Syntax:
  843. OCIConnectionPoolCreate (OCIEnv *envhp, OCIError *errhp, OCICPool *poolhp,
  844. OraText **poolName, sb4 *poolNameLen,
  845. CONST Oratext *dblink, sb4 dblinkLen,
  846. ub4 connMin, ub4 connMax, ub4 connIncr,
  847. CONST OraText *poolUsername, sb4 poolUserLen,
  848. CONST OraText *poolPassword, sb4 poolPassLen,
  849. ub4 mode)
  850. Comments:
  851. This call is used to create a connection pool. conn_min connections
  852. to the database are started on calling OCIConnectionPoolCreate.
  853. Parameters:
  854. envhp (IN/OUT) - A pointer to the environment where the Conencton Pool
  855. is to be created
  856. errhp (IN/OUT) - An error handle which can be passed to OCIErrorGet().
  857. poolhp (IN/OUT) - An uninitialiazed pool handle.
  858. poolName (OUT) - The connection pool name.
  859. poolNameLen (OUT) - The length of the connection pool name
  860. dblink (IN/OUT) - Specifies the database(server) to connect. This will also
  861. be used as the default pool name.
  862. dblinkLen (IN) - The length of the string pointed to by dblink.
  863. connMin (IN) - Specifies the minimum number of connections in the
  864. Connection Pool at any instant.
  865. connMin number of connections are started when
  866. OCIConnectionPoolCreate() is called.
  867. connMax (IN) - Specifies the maximum number of connections that can be
  868. opened to the database. Once this value is reached, no
  869. more connections are opened.
  870. connIncr (IN) - Allows application to set the next increment for
  871. connections to be opened to the database if the current
  872. number of connections are less than conn_max.
  873. poolUsername (IN/OUT) - Connection pooling requires an implicit proxy
  874. session and this attribute provides a username
  875. for that session.
  876. poolUserLen (IN) - This represents the length of pool_username.
  877. poolPassword (IN/OUT) - The password for the parameter pool_username passed
  878. above.
  879. poolPassLen (IN) - This represents the length of pool_password.
  880. mode (IN) - The modes supported are OCI_DEFAULT and
  881. OCI_CPOOL_REINITIALIZE
  882. Related Functions
  883. OCIConnectionPoolDestroy()
  884. ---------------------------------------------------------------------------
  885. ----------------------------OCIConnectionPoolDestroy-------------------------
  886. Name:
  887. OCIConnectionPoolDestroy
  888. Purpose:
  889. Terminates the connections in the pool
  890. Syntax:
  891. OCIConnectionPoolDestroy (OCICPool *poolhp, OCIError *errhp, ub4 mode)
  892. Comments:
  893. On calling OCIConnectionPoolDestroy, all the open connections in the pool
  894. are closed and the pool is destroyed.
  895. Parameters:
  896. poolhp (IN/OUT) - An initialiazed pool handle.
  897. errhp (IN/OUT) - An error handle which can be passed to OCIErrorGet().
  898. mode (IN) - Currently, OCIConnectionPoolDestroy() will support only
  899. the OCI_DEFAULT mode.
  900. Related Functions:
  901. OCIConnectionPoolCreate()
  902. -----------------------------------------------------------------------------
  903. ----------------------------OCISessionPoolCreate-----------------------------
  904. Name:
  905. OCISessionPoolCreate
  906. Purpose:
  907. Creates the sessions in the session pool.
  908. Syntax:
  909. sword OCISessionPoolCreate (OCIEnv *envhp, OCIError *errhp, OCISpool *spoolhp,
  910. OraText **poolName, ub4 *poolNameLen,
  911. CONST OraText *connStr, ub4 connStrLen,
  912. ub4 sessMin, ub4 sessMax, ub4 sessIncr,
  913. OraText *userid, ub4 useridLen,
  914. OraText *password, ub4 passwordLen,
  915. ub4 mode)
  916. Comments:
  917. When OCISessionPoolCreate is called, a session pool is initialized for
  918. the associated environment and the database specified by the
  919. connStr parameter. This pool is named uniquely and the name
  920. is returned to the user in the poolname parameter.
  921. Parameters:
  922. envhp (IN/OUT) - A pointer to the environment handle in which the session
  923. pool needs to be created.
  924. errhp (IN/OUT) - An error handle which can be passed to OCIErrorGet().
  925. spoolhp (IN/OUT) - A pointer to the session pool handle that is created.
  926. poolName (OUT) - Session pool name returned to the user.
  927. poolNameLen (OUT) - Length of the PoolName
  928. connStr (IN) - The TNS alias of the database to connect to.
  929. connStrLen (IN) - Length of the connStr.
  930. sessMin (IN) - Specifies the minimum number of sessions in the Session Pool.
  931. These are the number of sessions opened in the beginning, if
  932. in Homogeneous mode. Else, the parameter is ignored.
  933. sessMax (IN) - Specifies the maximum number of sessions in the Session Pool.
  934. Once this value is reached, no more sessions are opened,
  935. unless the OCI_ATTR_SPOOL_FORCEGET is set.
  936. userid (IN) - Specifies the userid with which to start up the sessions.
  937. useridLen (IN) - Length of userid.
  938. password (IN) - Specifies the password for the corresponding userid.
  939. passwordLen (IN) - Specifies the length of the password
  940. mode(IN) - May be OCI_DEFAULT, OCI_SPC_SPOOL_REINITIALIZE, or
  941. OCI_SPC_SPOOL_HOMOGENEOUS.
  942. Returns:
  943. SUCCESS - If pool could be allocated and created successfully.
  944. ERROR - If above conditions could not be met.
  945. Related Functions:
  946. OCISessionPoolDestroy()
  947. -----------------------------------------------------------------------------
  948. -----------------------------OCISessionPoolDestroy---------------------------
  949. Name:
  950. OCISessionPoolDestroy
  951. Purpose:
  952. Terminates all the sessions in the session pool.
  953. Syntax:
  954. sword OCISessionPoolDestroy (OCISPool *spoolhp, OCIError *errhp, ub4 mode)
  955. Comments:
  956. spoolhp (IN/OUT) - The pool handle of the session pool to be destroyed.
  957. errhp (IN/OUT) - An error handle which can be passed to OCIErrorGet().
  958. mode (IN) - Currently only OCI_DEFAULT mode is supported.
  959. Returns:
  960. SUCCESS - All the sessions could be closed.
  961. ERROR - If the above condition is not met.
  962. Related Functions:
  963. OCISessionPoolCreate()
  964. -----------------------------------------------------------------------------
  965. -------------------------------OCISessionGet---------------------------------
  966. Name:
  967. OCISessionGet
  968. Purpose:
  969. Get a session. This could be from a session pool, connection pool or
  970. a new standalone session.
  971. Syntax:
  972. sword OCISessionGet(OCIenv *envhp, OCIError *errhp, OCISvcCtx **svchp,
  973. OCIAuthInfo *authhp,
  974. OraText *poolName, ub4 poolName_len,
  975. CONST OraText *tagInfo, ub4 tagInfo_len,
  976. OraText **retTagInfo, ub4 *retTagInfo_len,
  977. boolean *found,
  978. ub4 mode)
  979. Comments:
  980. envhp (IN/OUT) - OCI environment handle.
  981. errhp (IN/OUT) - OCI error handle to be passed to OCIErrorGet().
  982. svchp (IN/OUT) - Address of an OCI service context pointer. This will be
  983. filled with a server and session handle, attached to the
  984. pool.
  985. authhp (IN/OUT) - OCI Authentication Information handle.
  986. poolName (IN) - This indicates the session/connection pool to get the
  987. session/connection from in the OCI_SPOOL/OCI_CPOOL mode.
  988. In the OCI_DEFAULT mode it refers to the connect string.
  989. poolName_len (IN) - length of poolName.
  990. tagInfo (IN) - indicates the tag of the session that the user wants. If the
  991. user wants a default session, he must specify a NULL here.
  992. Only used for Session Pooling.
  993. tagInfo_len (IN) - the length of tagInfo.
  994. retTagInfo (OUT) - This indicates the type of session that is returned to
  995. the user. Only used for Session Pooling.
  996. retTagInfo_len (OUT) - the length of retTagInfo.
  997. found (OUT) - set to true if the user gets a session he had requested, else
  998. set to false. Only used for Session Pooling.
  999. mode (IN) - The supported modes are OCI_DEFAULT, OCI_CRED_PROXY and
  1000. OCI_GET_SPOOL_MATCHANY, OCI_SPOOL and OCI_CPOOL. OCI_SPOOL and
  1001. OCI_CPOOL are mutually exclusive.
  1002. Returns:
  1003. SUCCESS - if a session was successfully returned into svchp.
  1004. SUCCESS_WITH_INFO - if a session was successfully returned into svchp and the
  1005. total number of sessions > maxsessions. Only valid for
  1006. Session Pooling.
  1007. ERROR - If a session could not be retrieved.
  1008. Related Functions:
  1009. OCISessionRelease()
  1010. -----------------------------------------------------------------------------
  1011. ---------------------------OCISessionRelease---------------------------------
  1012. Name:
  1013. OCISessionRelease
  1014. Purpose:
  1015. Release the session.
  1016. Syntax:
  1017. sword OCISessionRelease ( OCISvcCtx *svchp, OCIError *errhp,
  1018. OraText *tag, ub4 tag_len,
  1019. ub4 mode);
  1020. Comments:
  1021. svchp (IN/OUT) - The service context associated with the session/connection.
  1022. errhp (IN/OUT) - OCI error handle to be passed to OCIErrorGet().
  1023. tag (IN) - Only used for Session Pooling.
  1024. This parameter will be ignored unless mode OCI_RLS_SPOOL_RETAG is
  1025. specified. In this case, the session is labelled with this tag and
  1026. returned to the pool. If this is NULL, then the session is untagged.
  1027. tag_len (IN) - Length of the tag. This is ignored unless mode
  1028. OCI_RLS_SPOOL_RETAG is set.
  1029. mode (IN) - The supported modes are OCI_DEFAULT, OCI_RLS_SPOOL_DROPSESS,
  1030. OCI_RLS_SPOOL_RETAG. The last 2 are only valid for Session Pooling.
  1031. When OCI_RLS_SPOOL_DROPSESS is specified, the session
  1032. will be removed from the session pool. If OCI_RLS_SPOOL_RETAG
  1033. is set, the tag on the session will be altered. If this mode is
  1034. not set, the tag and tag_len parameters will be ignored.
  1035. Returns:
  1036. ERROR - If the session could not be released successfully.
  1037. SUCCESS - In all other cases.
  1038. Related Functions:
  1039. OCISessionGet().
  1040. -----------------------------------------------------------------------------
  1041. ------------------------------OCIDateTimeAssign --------------------------
  1042. sword OCIDateTimeAssign(dvoid *hndl, OCIError *err, CONST OCIDateTime *from,
  1043. OCIDateTime *to);
  1044. NAME: OCIDateTimeAssign - OCIDateTime Assignment
  1045. PARAMETERS:
  1046. hndl (IN) - Session/Env handle.
  1047. err (IN/OUT) - error handle. If there is an error, it is
  1048. recorded in 'err' and this function returns OCI_ERROR.
  1049. The error recorded in 'err' can be retrieved by calling
  1050. OCIErrorGet().
  1051. from (IN) - datetime to be assigned
  1052. to (OUT) - lhs of assignment
  1053. DESCRIPTION:
  1054. Performs date assignment. The type of the output will be same as that
  1055. of input
  1056. ------------------------------OCIDateTimeCheck----------------------------
  1057. sword OCIDateTimeCheck(dvoid *hndl, OCIError *err, CONST OCIDateTime *date,
  1058. ub4 *valid );
  1059. NAME: OCIDateTimeCheck - OCIDateTime CHecK if the given date is valid
  1060. PARAMETERS:
  1061. hndl (IN) - Session/Env handle.
  1062. err (IN/OUT) - error handle. If there is an error, it is
  1063. recorded in 'err' and this function returns OCI_ERROR.
  1064. The error recorded in 'err' can be retrieved by calling
  1065. OCIErrorGet().
  1066. date (IN) - date to be checked
  1067. valid (OUT) - returns zero for a valid date, otherwise
  1068. the ORed combination of all error bits specified below:
  1069. Macro name Bit number Error
  1070. ---------- ---------- -----
  1071. OCI_DATE_INVALID_DAY 0x1 Bad day
  1072. OCI_DATE_DAY_BELOW_VALID 0x2 Bad DAy Low/high bit (1=low)
  1073. OCI_DATE_INVALID_MONTH 0x4 Bad MOnth
  1074. OCI_DATE_MONTH_BELOW_VALID 0x8 Bad MOnth Low/high bit (1=low)
  1075. OCI_DATE_INVALID_YEAR 0x10 Bad YeaR
  1076. OCI_DATE_YEAR_BELOW_VALID 0x20 Bad YeaR Low/high bit (1=low)
  1077. OCI_DATE_INVALID_HOUR 0x40 Bad HouR
  1078. OCI_DATE_HOUR_BELOW_VALID 0x80 Bad HouR Low/high bit (1=low)
  1079. OCI_DATE_INVALID_MINUTE 0x100 Bad MiNute
  1080. OCI_DATE_MINUTE_BELOW_VALID 0x200 Bad MiNute Low/high bit (1=low)
  1081. OCI_DATE_INVALID_SECOND 0x400 Bad SeCond
  1082. OCI_DATE_SECOND_BELOW_VALID 0x800 bad second Low/high bit (1=low)
  1083. OCI_DATE_DAY_MISSING_FROM_1582 0x1000 Day is one of those "missing"
  1084. from 1582
  1085. OCI_DATE_YEAR_ZERO 0x2000 Year may not equal zero
  1086. OCI_DATE_INVALID_TIMEZONE 0x4000 Bad Timezone
  1087. OCI_DATE_INVALID_FORMAT 0x8000 Bad date format input
  1088. So, for example, if the date passed in was 2/0/1990 25:61:10 in
  1089. (month/day/year hours:minutes:seconds format), the error returned
  1090. would be OCI_DATE_INVALID_DAY | OCI_DATE_DAY_BELOW_VALID |
  1091. OCI_DATE_INVALID_HOUR | OCI_DATE_INVALID_MINUTE
  1092. DESCRIPTION:
  1093. Check if the given date is valid.
  1094. RETURNS:
  1095. OCI_SUCCESS if the function completes successfully.
  1096. OCI_INVALID_HANDLE if 'err' is NULL.
  1097. OCI_ERROR if
  1098. 'date' and 'valid' pointers are NULL pointers
  1099. ------------------------------- OCIDateTimeCompare----------------------------
  1100. sword OCIDateTimeCompare(dvoid *hndl, OCIError *err, CONST OCIDateTime *date1,
  1101. CONST OCIDateTime *date2, sword *result );
  1102. NAME: OCIDateTimeCompare - OCIDateTime CoMPare dates
  1103. PARAMETERS:
  1104. hndl (IN) - Session/Env handle.
  1105. err (IN/OUT) - error handle. If there is an error, it is
  1106. recorded in 'err' and this function returns OCI_ERROR.
  1107. The error recorded in 'err' can be retrieved by calling
  1108. OCIErrorGet().
  1109. date1, date2 (IN) - dates to be compared
  1110. result (OUT) - comparison result, 0 if equal, -1 if date1 < date2,
  1111. 1 if date1 > date2
  1112. DESCRIPTION:
  1113. The function OCIDateCompare compares two dates. It returns -1 if
  1114. date1 is smaller than date2, 0 if they are equal, and 1 if date1 is
  1115. greater than date2.
  1116. RETURNS:
  1117. OCI_SUCCESS if the function completes successfully.
  1118. OCI_INVALID_HANDLE if 'err' is NULL.
  1119. OCI_ERROR if
  1120. invalid date
  1121. input dates are not mutually comparable
  1122. ------------------------------OCIDateTimeConvert----------------------
  1123. sword OCIDateTimeConvert(dvoid *hndl, OCIError *err, OCIDateTime *indate,
  1124. OCIDateTime *outdate);
  1125. NAME: OCIDateTimeConvert - Conversion between different DATETIME types
  1126. PARAMETERS:
  1127. hndl (IN) - Session/Env handle.
  1128. err (IN/OUT) - error handle. If there is an error, it is
  1129. recorded in 'err' and this function returns OCI_ERROR.
  1130. The error recorded in 'err' can be retrieved by calling
  1131. OCIErrorGet().
  1132. indate (IN) - pointer to input date
  1133. outdate (OUT) - pointer to output datetime
  1134. DESCRIPTION: Converts one datetime type to another. The result type is
  1135. the type of the 'outdate' descriptor.
  1136. RETURNS:
  1137. OCI_SUCCESS if the function completes successfully.
  1138. OCI_INVALID_HANDLE if 'err' is NULL.
  1139. OCI_ERROR if
  1140. conversion not possible.
  1141. ---------------------------- OCIDateTimeFromText-----------------------
  1142. sword OCIDateTimeFromText(dvoid *hndl, OCIError *err, CONST OraText *date_str,
  1143. size_t d_str_length, CONST OraText *fmt, ub1 fmt_length,
  1144. CONST OraText *lang_name, size_t lang_length, OCIDateTime *date );
  1145. NAME: OCIDateTimeFromText - OCIDateTime convert String FROM Date
  1146. PARAMETERS:
  1147. hndl (IN) - Session/Env handle. If Session Handle is passed, the
  1148. conversion takes place in session NLS_LANGUAGE and
  1149. session NLS_CALENDAR, otherwise the default is used.
  1150. err (IN/OUT) - error handle. If there is an error, it is
  1151. recorded in 'err' and this function returns OCI_ERROR.
  1152. The error recorded in 'err' can be retrieved by calling
  1153. OCIErrorGet().
  1154. date_str (IN) - input string to be converted to Oracle date
  1155. d_str_length (IN) - size of the input string, if the length is -1
  1156. then 'date_str' is treated as a null terminated string
  1157. fmt (IN) - conversion format; if 'fmt' is a null pointer, then
  1158. the string is expected to be in the default format for
  1159. the datetime type.
  1160. fmt_length (IN) - length of the 'fmt' parameter
  1161. lang_name (IN) - language in which the names and abbreviations of
  1162. days and months are specified, if null i.e. (OraText *)0,
  1163. the default language of session is used,
  1164. lang_length (IN) - length of the 'lang_name' parameter
  1165. date (OUT) - given string converted to date
  1166. DESCRIPTION:
  1167. Converts the given string to Oracle datetime type set in the
  1168. OCIDateTime descriptor according to the specified format. Refer to
  1169. "TO_DATE" conversion function described in "Oracle SQL Language
  1170. Reference Manual" for a description of format.
  1171. RETURNS:
  1172. OCI_SUCCESS if the function completes successfully.
  1173. OCI_INVALID_HANDLE if 'err' is NULL.
  1174. OCI_ERROR if
  1175. invalid format
  1176. unknown language
  1177. invalid input string
  1178. --------------------------- OCIDateTimeGetDate-------------------------
  1179. sword OCIDateTimeGetDate(dvoid *hndl, OCIError *err, CONST OCIDateTime *date,
  1180. sb2 *year, ub1 *month, ub1 *day );
  1181. NAME: OCIDateTimeGetDate - OCIDateTime Get Date (year, month, day)
  1182. portion of DATETIME.
  1183. PARAMETERS:
  1184. hndl (IN) - Session/Env handle.
  1185. err (IN/OUT) - error handle. If there is an error, it is
  1186. recorded in 'err' and this function returns OCI_ERROR.
  1187. The error recorded in 'err' can be retrieved by calling
  1188. OCIErrorGet().
  1189. datetime (IN) - Pointer to OCIDateTime
  1190. year (OUT) - year value
  1191. month (OUT) - month value
  1192. day (OUT) - day value
  1193. --------------------------- OCIDateTimeGetTime ------------------------
  1194. sword OCIDateTimeGetTime(dvoid *hndl, OCIError *err, OCIDateTime *datetime,
  1195. ub1 *hour, ub1 *minute, ub1 *sec, ub4 *fsec);
  1196. NAME: OCIDateTimeGetTime - OCIDateTime Get Time (hour, min, second,
  1197. fractional second) of DATETIME.
  1198. PARAMETERS:
  1199. hndl (IN) - Session/Env handle.
  1200. err (IN/OUT) - error handle. If there is an error, it is
  1201. recorded in 'err' and this function returns OCI_ERROR.
  1202. The error recorded in 'err' can be retrieved by calling
  1203. OCIErrorGet().
  1204. datetime (IN) - Pointer to OCIDateTime
  1205. hour (OUT) - hour value
  1206. minute (OUT) - minute value
  1207. sec (OUT) - second value
  1208. fsec (OUT) - Fractional Second value
  1209. --------------------------- OCIDateTimeGetTimeZoneOffset ----------------------
  1210. sword OCIDateTimeGetTimeZoneOffset(dvoid *hndl,OCIError *err,CONST
  1211. OCIDateTime *datetime,sb1 *hour,sb1 *minute);
  1212. NAME: OCIDateTimeGetTimeZoneOffset - OCIDateTime Get TimeZone (hour, minute)
  1213. portion of DATETIME.
  1214. PARAMETERS:
  1215. hndl (IN) - Session/Env handle.
  1216. err (IN/OUT) - error handle. If there is an error, it is
  1217. recorded in 'err' and this function returns OCI_ERROR.
  1218. The error recorded in 'err' can be retrieved by calling
  1219. OCIErrorGet().
  1220. datetime (IN) - Pointer to OCIDateTime
  1221. hour (OUT) - TimeZone Hour value
  1222. minute (OUT) - TimeZone Minute value
  1223. --------------------------- OCIDateTimeSysTimeStamp---------------------
  1224. sword OCIDateTimeSysTimeStamp(dvoid *hndl, OCIError *err,
  1225. OCIDateTime *sys_date );
  1226. NAME: OCIDateTimeSysTimeStamp - Returns system date/time as a TimeStamp with
  1227. timezone
  1228. PARAMETERS:
  1229. hndl (IN) - Session/Env handle.
  1230. err (IN/OUT) - error handle. If there is an error, it is
  1231. recorded in 'err' and this function returns OCI_ERROR.
  1232. The error recorded in 'err' can be retrieved by calling
  1233. OCIErrorGet().
  1234. sys_date (OUT) - Pointer to output timestamp
  1235. DESCRIPTION:
  1236. Gets the system current date and time as a timestamp with timezone
  1237. RETURNS:
  1238. OCI_SUCCESS if the function completes successfully.
  1239. OCI_INVALID_HANDLE if 'err' is NULL.
  1240. ------------------------------OCIDateTimeIntervalAdd----------------------
  1241. sword OCIDateTimeIntervalAdd(dvoid *hndl, OCIError *err, OCIDateTime *datetime,
  1242. OCIInterval *inter, OCIDateTime *outdatetime);
  1243. NAME: OCIDateTimeIntervalAdd - Adds an interval to datetime
  1244. PARAMETERS:
  1245. hndl (IN) - Session/Env handle.
  1246. err (IN/OUT) - error handle. If there is an error, it is
  1247. recorded in 'err' and this function returns OCI_ERROR.
  1248. The error recorded in 'err' can be retrieved by calling
  1249. OCIErrorGet().
  1250. datetime (IN) - pointer to input datetime
  1251. inter (IN) - pointer to interval
  1252. outdatetime (IN) - pointer to output datetime. The output datetime
  1253. will be of same type as input datetime
  1254. DESCRIPTION:
  1255. Adds an interval to a datetime to produce a resulting datetime
  1256. RETURNS:
  1257. OCI_SUCCESS if the function completes successfully.
  1258. OCI_INVALID_HANDLE if 'err' is NULL.
  1259. OCI_ERROR if:
  1260. resulting date is before Jan 1, -4713
  1261. resulting date is after Dec 31, 9999
  1262. ------------------------------OCIDateTimeIntervalSub----------------------
  1263. sword OCIDateTimeIntervalSub(dvoid *hndl, OCIError *err, OCIDateTime *datetime,
  1264. OCIInterval *inter, OCIDateTime *outdatetime);
  1265. NAME: OCIDateTimeIntervalSub - Subtracts an interval from a datetime
  1266. PARAMETERS:
  1267. hndl (IN) - Session/Env handle.
  1268. err (IN/OUT) - error handle. If there is an error, it is
  1269. recorded in 'err' and this function returns OCI_ERROR.
  1270. The error recorded in 'err' can be retrieved by calling
  1271. OCIErrorGet().
  1272. datetime (IN) - pointer to input datetime
  1273. inter (IN) - pointer to interval
  1274. outdatetime (IN) - pointer to output datetime. The output datetime
  1275. will be of same type as input datetime
  1276. DESCRIPTION:
  1277. Subtracts an interval from a datetime and stores the result in a
  1278. datetime
  1279. RETURNS:
  1280. OCI_SUCCESS if the function completes successfully.
  1281. OCI_INVALID_HANDLE if 'err' is NULL.
  1282. OCI_ERROR if:
  1283. resulting date is before Jan 1, -4713
  1284. resulting date is after Dec 31, 9999
  1285. --------------------------- OCIDateTimeConstruct-------------------------
  1286. sword OCIDateTimeConstruct(dvoid *hndl,OCIError *err,OCIDateTime *datetime,
  1287. sb2 year,ub1 month,ub1 day,ub1 hour,ub1 min,ub1 sec,ub4 fsec,
  1288. OraText *timezone,size_t timezone_length);
  1289. NAME: OCIDateTimeConstruct - Construct an OCIDateTime. Only the relevant
  1290. fields for the OCIDateTime descriptor types are used.
  1291. PARAMETERS:
  1292. hndl (IN) - Session/Env handle.
  1293. err (IN/OUT) - error handle. If there is an error, it is
  1294. recorded in 'err' and this function returns OCI_ERROR.
  1295. The error recorded in 'err' can be retrieved by calling
  1296. OCIErrorGet().
  1297. datetime (IN) - Pointer to OCIDateTime
  1298. year (IN) - year value
  1299. month (IN) - month value
  1300. day (IN) - day value
  1301. hour (IN) - hour value
  1302. min (IN) - minute value
  1303. sec (IN) - second value
  1304. fsec (IN) - Fractional Second value
  1305. timezone (IN) - Timezone string
  1306. timezone_length(IN) - Length of timezone string
  1307. DESCRIPTION:
  1308. Constructs a DateTime descriptor. The type of the datetime is the
  1309. type of the OCIDateTime descriptor. Only the relevant fields based
  1310. on the type are used. For Types with timezone, the date and time
  1311. fields are assumed to be in the local time of the specified timezone.
  1312. If timezone is not specified, then session default timezone is
  1313. assumed.
  1314. RETURNS:
  1315. OCI_SUCCESS if the function completes successfully.
  1316. OCI_ERROR if datetime is not valid.
  1317. ------------------------------OCIDateTimeSubtract-----------------------
  1318. sword OCIDateTimeSubtract(dvoid *hndl, OCIError *err, OCIDateTime *indate1,
  1319. OCIDateTime *indate2, OCIInterval *inter);
  1320. NAME: OCIDateTimeSubtract - subtracts two datetimes to return an interval
  1321. PARAMETERS:
  1322. hndl (IN) - Session/Env handle.
  1323. err (IN/OUT) - error handle. If there is an error, it is
  1324. recorded in 'err' and this function returns OCI_ERROR.
  1325. The error recorded in 'err' can be retrieved by calling
  1326. OCIErrorGet().
  1327. indate1(IN) - pointer to subtrahend
  1328. indate2(IN) - pointer to minuend
  1329. inter (OUT) - pointer to output interval
  1330. DESCRIPTION:
  1331. Takes two datetimes as input and stores their difference in an
  1332. interval. The type of the interval is the type of the 'inter'
  1333. descriptor.
  1334. RETURNS:
  1335. OCI_SUCCESS if the function completes successfully.
  1336. OCI_INVALID_HANDLE if 'err' is NULL.
  1337. OCI_ERROR if
  1338. datetimes are not comparable.
  1339. --------------------------- OCIDateTimeToText--------------------------
  1340. sword OCIDateTimeToText(dvoid *hndl, OCIError *err, CONST OCIDateTime *date,
  1341. CONST OraText *fmt, ub1 fmt_length, ub1 fsprec,
  1342. CONST OraText *lang_name, size_t lang_length,
  1343. ub4 *buf_size, OraText *buf );
  1344. NAME: OCIDateTimeToText - OCIDateTime convert date TO String
  1345. PARAMETERS:
  1346. hndl (IN) - Session/Env handle. If Session Handle is passed, the
  1347. conversion takes place in session NLS_LANGUAGE and
  1348. session NLS_CALENDAR, otherwise the default is used.
  1349. err (IN/OUT) - error handle. If there is an error, it is
  1350. recorded in 'err' and this function returns OCI_ERROR.
  1351. The error recorded in 'err' can be retrieved by calling
  1352. OCIErrorGet().
  1353. date (IN) - Oracle datetime to be converted
  1354. fmt (IN) - conversion format, if null string pointer (OraText*)0, then
  1355. the date is converted to a character string in the
  1356. default format for that type.
  1357. fmt_length (IN) - length of the 'fmt' parameter
  1358. fsprec (IN) - specifies the fractional second precision in which the
  1359. fractional seconds is returned.
  1360. lang_name (IN) - specifies the language in which the names and
  1361. abbreviations of months and days are returned;
  1362. default language of session is used if 'lang_name'
  1363. is null i.e. (OraText *)0
  1364. lang_length (IN) - length of the 'nls_params' parameter
  1365. buf_size (IN/OUT) - size of the buffer; size of the resulting string
  1366. is returned via this parameter
  1367. buf (OUT) - buffer into which the converted string is placed
  1368. DESCRIPTION:
  1369. Converts the given date to a string according to the specified format.
  1370. Refer to "TO_DATE" conversion function described in
  1371. "Oracle SQL Language Reference Manual" for a description of format
  1372. and NLS arguments. The converted null-terminated date string is
  1373. stored in the buffer 'buf'.
  1374. RETURNS:
  1375. OCI_SUCCESS if the function completes successfully.
  1376. OCI_INVALID_HANDLE if 'err' is NULL.
  1377. OCI_ERROR if
  1378. buffer too small
  1379. invalid format
  1380. unknown language
  1381. overflow error
  1382. ----------------------------OCIDateTimeGetTimeZoneName------------------------
  1383. sword OCIDateTimeGetTimeZoneName(dvoid *hndl,
  1384. OCIError *err,
  1385. CONST OCIDateTime *datetime,
  1386. ub1 *buf,
  1387. ub4 *buflen);
  1388. NAME OCIDateTimeGetTimeZoneName - OCI DateTime Get the Time Zone Name
  1389. PARAMETERS:
  1390. hndl (IN) - Session/Env handle.
  1391. err (IN/OUT) - error handle. If there is an error, it is
  1392. recorded in 'err' and this function returns OCI_ERROR.
  1393. The error recorded in 'err' can be retrieved by calling
  1394. OCIErrorGet().
  1395. datetime (IN) - Pointer to an OCIDateTime.
  1396. buf (OUT) - User allocated storage for name string.
  1397. buflen (IN/OUT) - length of buf on input, length of name on out
  1398. DESCRIPTION:
  1399. Returns either the timezone region name or the absolute hour and minute
  1400. offset. If the DateTime was created with a region id then the region
  1401. name will be returned in the buf. If the region id is zero, then the
  1402. hour and minute offset is returned as "[-]HH:MM".
  1403. RETURNS:
  1404. OCI_SUCCESS if the function completes successfully.
  1405. OCI_INVALID_HANDLE if 'err' is NULL.
  1406. OCI_ERROR if
  1407. buffer too small
  1408. error retrieving timezone data
  1409. invalid region
  1410. invalid LdiDateTime type
  1411. ---------------------------------OCIDateTimeToArray----------------------------
  1412. sword OCIDateTimeToArray(dvoid *hndl,
  1413. OCIError *err,
  1414. CONST OCIDateTime *datetime,
  1415. CONST OCIInterval *reftz,
  1416. ub1 *outarray,
  1417. ub4 *len
  1418. ub1 *fsprec);
  1419. NAME OCIDateTimeToArray - OCI DateTime convert To Array format
  1420. PARAMETERS:
  1421. hndl (IN) - Session/Env handle.
  1422. err (IN/OUT) - error handle. If there is an error, it is
  1423. recorded in 'err' and this function returns OCI_ERROR.
  1424. The error recorded in 'err' can be retrieved by calling
  1425. OCIErrorGet().
  1426. datetime (IN) - Pointer to OCIDateTime to be converted.
  1427. outarray (OUT) - Result array storage
  1428. len (OUT) - pointer to length of outarray.
  1429. fsprec (IN) - Number of fractional seconds digits.
  1430. DESCRIPTION:
  1431. Returns an array representing the input DateTime descriptor.
  1432. RETURNS:
  1433. OCI_SUCCESS if the function completes successfully.
  1434. OCI_INVALID_HANDLE if 'err' is NULL.
  1435. OCI_ERROR if
  1436. buffer too small
  1437. error retrieving timezone data
  1438. invalid region
  1439. invalid LdiDateTime type
  1440. --------------------------------OCIDateTimeFromArray---------------------------
  1441. sword OCIDateTimeFromArray(dvoid *hndl,
  1442. OCIError *err,
  1443. ub1 *inarray,
  1444. ub4 len
  1445. ub1 type
  1446. OCIDateTime *datetime,
  1447. OCIInterval *reftz,
  1448. ub1 fsprec);
  1449. NAME OCIDateTimeFromArray - OCI DateTime convert From Array format
  1450. PARAMETERS:
  1451. hndl (IN) - Session/Env handle.
  1452. err (IN/OUT) - error handle. If there is an error, it is
  1453. recorded in 'err' and this function returns OCI_ERROR.
  1454. The error recorded in 'err' can be retrieved by calling
  1455. OCIErrorGet().
  1456. inarray (IN) - Pointer to input array representtion of DateTime
  1457. len (IN) - len of inarray.
  1458. type (IN) - One of SQLT_DATE, SQLT_TIME, SQLT_TIME_TZ, SQLT_TIMESTAMP,
  1459. SQLT_TIMESTAMP_TZ, or SQLT_TIMESTAMP_LTZ.
  1460. datetime (OUT) - Pointer to the result OCIDateTime.
  1461. reftz (IN) - timezone interval used with SQLT_TIMESTAMP_LTZ.
  1462. fsprec (IN) - fractionl seconds digits of precision (0-9).
  1463. DESCRIPTION:
  1464. Returns a pointer to an OCIDateTime of type type converted from
  1465. the inarray.
  1466. RETURNS:
  1467. OCI_SUCCESS if the function completes successfully.
  1468. OCI_INVALID_HANDLE if 'err' is NULL.
  1469. OCI_ERROR if
  1470. buffer too small
  1471. error retrieving timezone data
  1472. invalid region
  1473. invalid LdiDateTime type
  1474. ----------------------------------OCIRowidToChar-----------------------------
  1475. Name
  1476. OCIRowidToChar
  1477. Purpose
  1478. Converts physical/logical (universal) ROWID to chracter extended (Base 64)
  1479. representation into user provided buffer outbfp of length outbflp. After
  1480. execution outbflp contains amount of bytes converted.In case of truncation
  1481. error, outbflp contains required size to make this conversion successful
  1482. and returns ORA-1405.
  1483. Syntax
  1484. sword OCIRowidToChar( OCIRowid *rowidDesc,
  1485. OraText *outbfp,
  1486. ub2 *outbflp,
  1487. OCIError *errhp)
  1488. Comments
  1489. After this conversion, ROWID in character format can be bound using
  1490. OCIBindByPos or OCIBindByName call and used to query a row at a
  1491. desired ROWID.
  1492. Parameters
  1493. rowidDesc (IN) - rowid DESCriptor which is allocated from OCIDescritorAlloc
  1494. and populated by a prior SQL statement execution
  1495. outbfp (OUT) - pointer to the buffer where converted rowid in character
  1496. representation is stored after successful execution.
  1497. outbflp (IN/OUT) - pointer to output buffer length variable.
  1498. Before execution (IN mode) *outbflp contains the size of
  1499. outbfp, after execution (OUT mode) *outbflp contains amount
  1500. of bytes converted. In an event of truncation during
  1501. conversion *outbflp contains the required length to make
  1502. conversion successful.
  1503. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  1504. diagnostic information in the event of an error.
  1505. ------------------------------OCIDefineArrayOfStruct--------------------------
  1506. OCIDefineArrayOfStruct()
  1507. Name
  1508. OCI Define for Array of Structures
  1509. Purpose
  1510. This call specifies additional attributes necessary for a static array define.
  1511. Syntax
  1512. sword OCIDefineArrayOfStruct ( OCIDefine *defnp,
  1513. OCIError *errhp,
  1514. ub4 pvskip,
  1515. ub4 indskip,
  1516. ub4 rlskip,
  1517. ub4 rcskip );
  1518. Comments
  1519. This call specifies additional attributes necessary for an array define,
  1520. used in an array of structures (multi-row, multi-column) fetch.
  1521. For more information about skip parameters, see the section "Skip Parameters"
  1522. on page 4-17.
  1523. Parameters
  1524. defnp (IN) - the handle to the define structure which was returned by a call
  1525. to OCIDefineByPos().
  1526. errhp (IN) - an error handle which can be passed to OCIErrorGet() for
  1527. diagnostic information in the event of an error.
  1528. pvskip (IN) - skip parameter for the next data value.
  1529. indskip (IN) - skip parameter for the next indicator location.
  1530. rlskip (IN) - skip parameter for the next return length value.
  1531. rcskip (IN) - skip parameter for the next return code.
  1532. Related Functions
  1533. OCIAttrGet()
  1534. OCIDefineByPos()
  1535. Name
  1536. OCI Define By Position
  1537. Purpose
  1538. Associates an item in a select-list with the type and output data buffer.
  1539. Syntax
  1540. sb4 OCIDefineByPos (
  1541. OCIStmt *stmtp,
  1542. OCIDefine **defnp,
  1543. OCIError *errhp,
  1544. ub4 position,
  1545. dvoid *valuep,
  1546. sb4 value_sz,
  1547. ub2 dty,
  1548. dvoid *indp,
  1549. ub2 *rlenp,
  1550. ub2 *rcodep,
  1551. ub4 mode );
  1552. Comments
  1553. This call defines an output buffer which will receive data retreived from
  1554. Oracle. The define is a local step which is necessary when a SELECT statement
  1555. returns data to your OCI application.
  1556. This call also implicitly allocates the define handle for the select-list item.
  1557. Defining attributes of a column for a fetch is done in one or more calls. The
  1558. first call is to OCIDefineByPos(), which defines the minimal attributes
  1559. required to specify the fetch.
  1560. This call takes as a parameter a define handle, which must have been
  1561. previously allocated with a call to OCIHandleAlloc().
  1562. Following the call to OCIDefineByPos() additional define calls may be
  1563. necessary for certain data types or fetch modes:
  1564. A call to OCIDefineArrayOfStruct() is necessary to set up skip parameters
  1565. for an array fetch of multiple columns.
  1566. A call to OCIDefineObject() is necessary to set up the appropriate
  1567. attributes of a named data type fetch. In this case the data buffer pointer
  1568. in ocidefn() is ignored.
  1569. Both OCIDefineArrayOfStruct() and OCIDefineObject() must be called
  1570. after ocidefn() in order to fetch multiple rows with a column of named
  1571. data types.
  1572. For a LOB define, the buffer pointer must be a lob locator of type
  1573. OCILobLocator , allocated by the OCIDescAlloc() call. LOB locators, and not
  1574. LOB values, are always returned for a LOB column. LOB values can then be
  1575. fetched using OCI LOB calls on the fetched locator.
  1576. For NCHAR (fixed and varying length), the buffer pointer must point to an
  1577. array of bytes sufficient for holding the required NCHAR characters.
  1578. Nested table columns are defined and fetched like any other named data type.
  1579. If the mode parameter is this call is set to OCI_DYNAMIC_FETCH, the client
  1580. application can fetch data dynamically at runtime.
  1581. Runtime data can be provided in one of two ways:
  1582. callbacks using a user-defined function which must be registered with a
  1583. subsequent call to OCIDefineDynamic(). When the client library needs a
  1584. buffer to return the fetched data, the callback will be invoked and the
  1585. runtime buffers provided will return a piece or the whole data.
  1586. a polling mechanism using calls supplied by the OCI. This mode is
  1587. assumed if no callbacks are defined. In this case, the fetch call returns the
  1588. OCI_NEED_DATA error code, and a piecewise polling method is used
  1589. to provide the data.
  1590. Related Functions: For more information about using the
  1591. OCI_DYNAMIC_FETCH mode, see the section "Runtime Data
  1592. Allocation and Piecewise Operations" on page 5-16 of Volume 1..
  1593. For more information about the define step, see the section "Defining"
  1594. on page 2-30.
  1595. Parameters
  1596. stmtp (IN) - a handle to the requested SQL query operation.
  1597. defnp (IN/OUT) - a pointer to a pointer to a define handle which is implicitly
  1598. allocated by this call. This handle is used to store the define information
  1599. for this column.
  1600. errhp (IN) - an error handle which can be passed to OCIErrorGet() for
  1601. diagnostic information in the event of an error.
  1602. position (IN) - the position of this value in the select list. Positions are
  1603. 1-based and are numbered from left to right. For example, in the SELECT
  1604. statement
  1605. SELECT empno, ssn, mgrno FROM employees;
  1606. empno is at position 1, ssn is at position 2, and mgrno is at position 3.
  1607. valuep (IN/OUT) - a pointer to a buffer or an array of buffers of the type
  1608. specified in the dty parameter. A number of buffers can be specified when
  1609. results for more than one row are desired in a single fetch call.
  1610. value_sz (IN) - the size of each valuep buffer in bytes. If the data is stored
  1611. internally in VARCHAR2 format, the number of characters desired, if different
  1612. from the buffer size in bytes, may be additionally specified by the using
  1613. OCIAttrSet().
  1614. In an NLS conversion environment, a truncation error will be generated if the
  1615. number of bytes specified is insufficient to handle the number of characters
  1616. desired.
  1617. dty (IN) - the data type. Named data type (SQLT_NTY) and REF (SQLT_REF)
  1618. are valid only if the environment has been intialized with in object mode.
  1619. indp - pointer to an indicator variable or array. For scalar data types,
  1620. pointer to sb2 or an array of sb2s. Ignored for named data types. For named
  1621. data types, a pointer to a named data type indicator structure or an array of
  1622. named data type indicator structures is associated by a subsequent
  1623. OCIDefineObject() call.
  1624. See the section "Indicator Variables" on page 2-43 for more information about
  1625. indicator variables.
  1626. rlenp (IN/OUT) - pointer to array of length of data fetched. Each element in
  1627. rlenp is the length of the data in the corresponding element in the row after
  1628. the fetch.
  1629. rcodep (OUT) - pointer to array of column-level return codes
  1630. mode (IN) - the valid modes are:
  1631. OCI_DEFAULT. This is the default mode.
  1632. OCI_DYNAMIC_FETCH. For applications requiring dynamically
  1633. allocated data at the time of fetch, this mode must be used. The user may
  1634. additionally call OCIDefineDynamic() to set up a callback function that
  1635. will be invoked to receive the dynamically allocated buffers and to set
  1636. up the memory allocate/free callbacks and the context for the callbacks.
  1637. valuep and value_sz are ignored in this mode.
  1638. Related Functions
  1639. OCIDefineArrayOfStruct(), OCIDefineDynamic(), OCIDefineObject()
  1640. OCIDefineDynamic()
  1641. Name
  1642. OCI Define Dynamic Fetch Attributes
  1643. Purpose
  1644. This call is used to set the additional attributes required if the
  1645. OCI_DYNAMIC_FETCH mode was selected in OCIDefineByPos().
  1646. Syntax
  1647. sword OCIDefineDynamic( OCIDefine *defnp,
  1648. OCIError *errhp,
  1649. dvoid *octxp,
  1650. OCICallbackDefine (ocbfp)(
  1651. dvoid *octxp,
  1652. OCIDefine *defnp,
  1653. ub4 iter,
  1654. dvoid **bufpp,
  1655. ub4 **alenpp,
  1656. ub1 *piecep,
  1657. dvoid **indpp,
  1658. ub2 **rcodep) );
  1659. Comments
  1660. This call is used to set the additional attributes required if the
  1661. OCI_DYNAMIC_FETCH mode has been selected in a call to
  1662. OCIDefineByPos().
  1663. When the OCI_DYNAMIC_FETCH mode is selected, buffers will be
  1664. dynamically allocated for REF, and named data type, values to receive the
  1665. data. The pointers to these buffers will be returned.
  1666. If OCI_DYNAMIC_FETCH mode was selected, and the call to
  1667. OCIDefineDynamic() is skipped, then the application can fetch data piecewise
  1668. using OCI calls.
  1669. For more information about OCI_DYNAMIC_FETCH mode, see the section
  1670. "Runtime Data Allocation and Piecewise Operations" on page 5-16.
  1671. Parameters
  1672. defnp (IN/OUT) - the handle to a define structure returned by a call to
  1673. OCIDefineByPos().
  1674. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  1675. diagnostic information in the event of an error.
  1676. octxp (IN) - points to a context for the callback function.
  1677. ocbfp (IN) - points to a callback function. This is invoked at runtime to get
  1678. a pointer to the buffer into which the fetched data or a piece of it will be
  1679. retreived. The callback also specifies the indicator, the return code and the
  1680. lengths of the data piece and indicator. The callback has the following
  1681. parameters:
  1682. octxp (IN) - a context pointer passed as an argument to all the callback
  1683. functions.
  1684. defnp (IN) - the define handle.
  1685. iter (IN) - which row of this current fetch.
  1686. bufpp (OUT) - returns a pointer to a buffer to store the column value, ie.
  1687. *bufp points to some appropriate storage for the column value.
  1688. alenpp (OUT) - returns a pointer to the length of the buffer. *alenpp
  1689. contains the size of the buffer after return from callback. Gets set to
  1690. actual data size after fetch.
  1691. piecep (IN/OUT) - returns a piece value, as follows:
  1692. The IN value can be OCI_ONE_PIECE, OCI_FIRST_PIECE or
  1693. OCI_NEXT_PIECE.
  1694. The OUT value can be OCI_ONE_PIECE if the IN value was
  1695. OCI_ONE_PIECE.
  1696. The OUT value can be OCI_ONE_PIECE or OCI_FIRST_PIECE if
  1697. the IN value was OCI_FIRST_PIECE.
  1698. The OUT value can only be OCI_NEXT_PIECE or
  1699. OCI_LAST_PIECE if the IN value was OCI_NEXT_PIECE.
  1700. indpp (IN) - indicator variable pointer
  1701. rcodep (IN) - return code variable pointer
  1702. Related Functions
  1703. OCIAttrGet()
  1704. OCIDefineObject()
  1705. OCIDefineObject()
  1706. Name
  1707. OCI Define Named Data Type attributes
  1708. Purpose
  1709. Sets up additional attributes necessary for a Named Data Type define.
  1710. Syntax
  1711. sword OCIDefineObject ( OCIDefine *defnp,
  1712. OCIError *errhp,
  1713. CONST OCIType *type,
  1714. dvoid **pgvpp,
  1715. ub4 *pvszsp,
  1716. dvoid **indpp,
  1717. ub4 *indszp );
  1718. Comments
  1719. This call sets up additional attributes necessary for a Named Data Type define.
  1720. An error will be returned if this function is called when the OCI environment
  1721. has been initialized in non-Object mode.
  1722. This call takes as a paramter a type descriptor object (TDO) of datatype
  1723. OCIType for the named data type being defined. The TDO can be retrieved
  1724. with a call to OCITypeByName().
  1725. See the description of OCIInitialize() on page 13 - 43 for more information
  1726. about initializing the OCI process environment.
  1727. Parameters
  1728. defnp (IN/OUT) - a define handle previously allocated in a call to
  1729. OCIDefineByPos().
  1730. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  1731. diagnostic information in the event of an error.
  1732. type (IN, optional) - points to the Type Descriptor Object (TDO) which
  1733. describes the type of the program variable. Only used for program variables
  1734. of type SQLT_NTY. This parameter is optional, and may be passed as NULL
  1735. if it is not being used.
  1736. pgvpp (IN/OUT) - points to a pointer to a program variable buffer. For an
  1737. array, pgvpp points to an array of pointers. Memory for the fetched named data
  1738. type instance(s) is dynamically allocated in the object cache. At the end of
  1739. the fetch when all the values have been received, pgvpp points to the
  1740. pointer(s) to these newly allocated named data type instance(s). The
  1741. application must call OCIObjectMarkDel() to deallocate the named data type
  1742. instance(s) when they are no longer needed.
  1743. pvszsp (IN/OUT) - points to the size of the program variable. For an array, it
  1744. is an array of ub4s. On return points to the size(s) of unpickled fetched
  1745. values.
  1746. indpp (IN/OUT) - points to a pointer to the program variable buffer
  1747. containing the parallel indicator structure. For an array, points to an array
  1748. of pointers. Memory is allocated to store the indicator structures in the
  1749. object cache. At the end of the fetch when all values have been received,
  1750. indpp points to the pointer(s) to these newly allocated indicator structure(s).
  1751. indszp (IN/OUT) - points to the size(s) of the indicator structure program
  1752. variable. For an array, it is an array of ub4s. On return points to the size(s)
  1753. of the unpickled fetched indicator values.
  1754. Related Functions
  1755. OCIAttrGet()
  1756. OCIDescAlloc()
  1757. Name
  1758. OCI Get DESCriptor or lob locator
  1759. Purpose
  1760. Allocates storage to hold certain data types. The descriptors can be used as
  1761. bind or define variables.
  1762. Syntax
  1763. sword OCIDescAlloc ( CONST dvoid *parenth,
  1764. dvoid **descpp,
  1765. ub4 type,
  1766. size_t xtramem_sz,
  1767. dvoid **usrmempp);
  1768. Comments
  1769. Returns a pointer to an allocated and initialized structure, corresponding to
  1770. the type specified in type. A non-NULL descriptor or LOB locator is returned
  1771. on success. No diagnostics are available on error.
  1772. This call returns OCI_SUCCESS if successful, or OCI_INVALID_HANDLE if
  1773. an out-of-memory error occurs.
  1774. Parameters
  1775. parenth (IN) - an environment handle.
  1776. descpp (OUT) - returns a descriptor or LOB locator of desired type.
  1777. type (IN) - specifies the type of descriptor or LOB locator to be allocated.
  1778. The specific types are:
  1779. OCI_DTYPE_SNAP - specifies generation of snapshot descriptor of C
  1780. type - OCISnapshot
  1781. OCI_DTYPE_LOB - specifies generation of a LOB data type locator of C
  1782. type - OCILobLocator
  1783. OCI_DTYPE_RSET - specifies generation of a descriptor of C type
  1784. OCIResult that references a result set (a number of rows as a result of a
  1785. query). This descriptor is bound to a bind variable of data type
  1786. SQLT_RSET (result set). The descriptor has to be converted into a
  1787. statement handle using a function - OCIResultSetToStmt() - which can
  1788. then be passed to OCIDefineByPos() and OCIStmtFetch() to retrieve the
  1789. rows of the result set.
  1790. OCI_DTYPE_ROWID - specifies generation of a ROWID descriptor of C
  1791. type OCIRowid.
  1792. OCI_DTYPE_COMPLEXOBJECTCOMP - specifies generation of a
  1793. complex object retrieval descriptor of C type
  1794. OCIComplexObjectComp.
  1795. xtramemsz (IN) - specifies an amount of user memory to be allocated for use
  1796. by the application.
  1797. usrmempp (OUT) - returns a pointer to the user memory of size xtramemsz
  1798. allocated by the call for the user.
  1799. Related Functions
  1800. OCIDescFree()
  1801. OCIDescFree()
  1802. Name
  1803. OCI Free DESCriptor
  1804. Purpose
  1805. Deallocates a previously allocated descriptor.
  1806. Syntax
  1807. sword OCIDescFree ( dvoid *descp,
  1808. ub4 type);
  1809. Comments
  1810. This call frees up storage associated with the descriptor, corresponding to the
  1811. type specified in type. Returns OCI_SUCCESS or OCI_INVALID_HANDLE.
  1812. All descriptors must be explicitly deallocated. OCI will not deallocate a
  1813. descriptor if the environment handle is deallocated.
  1814. Parameters
  1815. descp (IN) - an allocated descriptor.
  1816. type (IN) - specifies the type of storage to be freed. The specific types are:
  1817. OCI_DTYPE_SNAP - snapshot descriptor
  1818. OCI_DTYPE_LOB - a LOB data type descriptor
  1819. OCI_DTYPE_RSET - a descriptor that references a result set (a number
  1820. of rows as a result of a query).
  1821. OCI_DTYPE_ROWID - a ROWID descriptor
  1822. OCI_DTYPE_COMPLEXOBJECTCOMP - a complex object retrieval
  1823. descriptor
  1824. Related Functions
  1825. OCIDescAlloc()
  1826. OCIDescribeAny()
  1827. Name
  1828. OCI DeSCribe Any
  1829. Purpose
  1830. Describes existing schema objects.
  1831. Syntax
  1832. sword OCIDescribeAny ( OCISvcCtx *svchp,
  1833. OCIError *errhp,
  1834. dvoid *objptr,
  1835. ub4 objnm_len,
  1836. ub1 objptr_typ,
  1837. ub1 info_level,
  1838. ub1 objtype,
  1839. OCIDesc *dschp );
  1840. Comments
  1841. This is a generic describe call that describes existing schema objects: tables,
  1842. views, synonyms, procedures, functions, packages, sequences, and types. As a
  1843. result of this call, the describe handle is populated with the object-specific
  1844. attributes which can be obtained through an OCIAttrGet() call.
  1845. An OCIParamGet() on the describe handle returns a parameter descriptor for a
  1846. specified position. Parameter positions begin with 1. Calling OCIAttrGet() on
  1847. the parameter descriptor returns the specific attributes of a stored procedure
  1848. or function parameter or a table column descriptor as the case may be.
  1849. These subsequent calls do not need an extra round trip to the server because
  1850. the entire schema object description cached on the client side by
  1851. OCIDescribeAny(). Calling OCIAttrGet() on the describe handle can also return
  1852. the total number of positions.
  1853. See the section "Describing" on page 2-33 for more information about describe
  1854. operations.
  1855. Parameters
  1856. TO BE UPDATED
  1857. svchp (IN/OUT) - a service context handle.
  1858. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  1859. diagnostic information in the event of an error.
  1860. objptr (IN) - the name of the object (a null-terminated string) to be
  1861. described. Only procedure or function names are valid when connected to an
  1862. Oracle7 Server.
  1863. objptr_len (IN) - the length of the string. Must be non-zero.
  1864. objptr_typ (IN) - Must be OCI_OTYPE_NAME, OCI_OTYPE_REF, or OCI_OTYPE_PTR.
  1865. info_level (IN) - reserved for future extensions. Pass OCI_DEFAULT.
  1866. objtype (IN/OUT) - object type.
  1867. dschp (IN/OUT) - a describe handle that is populated with describe
  1868. information about the object after the call.
  1869. Related Functions
  1870. OCIAttrGet()
  1871. OCIEnvCreate()
  1872. Name
  1873. OCI ENVironment CREATE
  1874. Purpose
  1875. This function creates and initializes an environment for the rest of
  1876. the OCI functions to work under. This call is a replacement for both
  1877. the OCIInitialize and OCIEnvInit calls.
  1878. Syntax
  1879. sword OCIEnvCreate ( OCIEnv **envhpp,
  1880. ub4 mode,
  1881. CONST dvoid *ctxp,
  1882. CONST dvoid *(*malocfp)
  1883. (dvoid *ctxp,
  1884. size_t size),
  1885. CONST dvoid *(*ralocfp)
  1886. (dvoid *ctxp,
  1887. dvoid *memptr,
  1888. size_t newsize),
  1889. CONST void (*mfreefp)
  1890. ( dvoid *ctxp,
  1891. dvoid *memptr))
  1892. size_t xtramemsz,
  1893. dvoid **usrmempp );
  1894. Comments
  1895. This call creates an environment for all the OCI calls using the modes
  1896. specified by the user. This call can be used instead of the two calls
  1897. OCIInitialize and OCIEnvInit. This function returns an environment handle
  1898. which is then used by the remaining OCI functions. There can be multiple
  1899. environments in OCI each with its own environment modes. This function
  1900. also performs any process level initialization if required by any mode.
  1901. For example if the user wants to initialize an environment as OCI_THREADED,
  1902. then all libraries that are used by OCI are also initialized in the
  1903. threaded mode.
  1904. This call should be invoked before anny other OCI call and should be used
  1905. instead of the OCIInitialize and OCIEnvInit calls. This is the recommended
  1906. call, although OCIInitialize and OCIEnvInit calls will still be supported
  1907. for backward compatibility.
  1908. envpp (OUT) - a pointer to a handle to the environment.
  1909. mode (IN) - specifies initialization of the mode. The valid modes are:
  1910. OCI_DEFAULT - default mode.
  1911. OCI_THREADED - threaded environment. In this mode, internal data
  1912. structures are protected from concurrent accesses by multiple threads.
  1913. OCI_OBJECT - will use navigational object interface.
  1914. ctxp (IN) - user defined context for the memory call back routines.
  1915. malocfp (IN) - user-defined memory allocation function. If mode is
  1916. OCI_THREADED, this memory allocation routine must be thread safe.
  1917. ctxp - context pointer for the user-defined memory allocation function.
  1918. size - size of memory to be allocated by the user-defined memory
  1919. allocation function
  1920. ralocfp (IN) - user-defined memory re-allocation function. If mode is
  1921. OCI_THREADED, this memory allocation routine must be thread safe.
  1922. ctxp - context pointer for the user-defined memory reallocation
  1923. function.
  1924. memp - pointer to memory block
  1925. newsize - new size of memory to be allocated
  1926. mfreefp (IN) - user-defined memory free function. If mode is
  1927. OCI_THREADED, this memory free routine must be thread safe.
  1928. ctxp - context pointer for the user-defined memory free function.
  1929. memptr - pointer to memory to be freed
  1930. xtramemsz (IN) - specifies the amount of user memory to be allocated.
  1931. usrmempp (OUT) - returns a pointer to the user memory of size xtramemsz
  1932. allocated by the call for the user.
  1933. Example
  1934. Related Functions
  1935. OCIInitialize, OCIEnvInit
  1936. OCIEnvNlsCreate()
  1937. Name
  1938. OCI ENVironment CREATE with NLS info
  1939. Purpose
  1940. This function does almost everything OCIEnvCreate does, plus enabling setting
  1941. of charset and ncharset programmatically, except OCI_UTF16 mode.
  1942. Syntax
  1943. sword OCIEnvNlsCreate(OCIEnv **envhpp,
  1944. ub4 mode,
  1945. dvoid *ctxp,
  1946. dvoid *(*malocfp)
  1947. (dvoid *ctxp,
  1948. size_t size),
  1949. dvoid *(*ralocfp)
  1950. (dvoid *ctxp,
  1951. dvoid *memptr,
  1952. size_t newsize),
  1953. void (*mfreefp)
  1954. (dvoid *ctxp,
  1955. dvoid *memptr),
  1956. size_t xtramemsz,
  1957. dvoid **usrmempp,
  1958. ub2 charset,
  1959. ub2 ncharset)
  1960. Comments
  1961. The charset and ncharset must be both zero or non-zero.
  1962. The parameters have the same meaning as the ones in OCIEnvCreate().
  1963. When charset or ncharset is non-zero, the corresponding character set will
  1964. be used to replace the ones specified in NLS_LANG or NLS_NCHAR. Moreover,
  1965. OCI_UTF16ID is allowed to be set as charset and ncharset.
  1966. On the other hand, OCI_UTF16 mode is deprecated with this function.
  1967. Applications can achieve the same effects by setting
  1968. both charset and ncharset as OCI_UTF16ID.
  1969. OCIEnvInit()
  1970. Name
  1971. OCI INITialize environment
  1972. Purpose
  1973. This call initializes the OCI environment handle.
  1974. Syntax
  1975. sword OCIEnvInit ( OCIEnv **envp,
  1976. ub4 mode,
  1977. size_t xtramemsz,
  1978. dvoid **usrmempp );
  1979. Comments
  1980. Initializes the OCI environment handle. No changes are done on an initialized
  1981. handle. If OCI_ERROR or OCI_SUCCESS_WITH_INFO is returned, the
  1982. environment handle can be used to obtain ORACLE specific errors and
  1983. diagnostics.
  1984. This call is processed locally, without a server round-trip.
  1985. Parameters
  1986. envpp (OUT) - a pointer to a handle to the environment.
  1987. mode (IN) - specifies initialization of an environment mode. The only valid
  1988. mode is OCI_DEFAULT for default mode
  1989. xtramemsz (IN) - specifies the amount of user memory to be allocated.
  1990. usrmempp (OUT) - returns a pointer to the user memory of size xtramemsz
  1991. allocated by the call for the user.
  1992. Example
  1993. See the description of OCISessionBegin() on page 13-84 for an example showing
  1994. the use of OCIEnvInit().
  1995. Related Functions
  1996. OCIErrorGet()
  1997. Name
  1998. OCI Get Diagnostic Record
  1999. Purpose
  2000. Returns an error message in the buffer provided and an ORACLE error.
  2001. Syntax
  2002. sword OCIErrorGet ( dvoid *hndlp,
  2003. ub4 recordno,
  2004. OraText *sqlstate,
  2005. ub4 *errcodep,
  2006. OraText *bufp,
  2007. ub4 bufsiz,
  2008. ub4 type );
  2009. Comments
  2010. Returns an error message in the buffer provided and an ORACLE error.
  2011. Currently does not support SQL state. This call can be called a multiple
  2012. number of times if there are more than one diagnostic record for an error.
  2013. The error handle is originally allocated with a call to OCIHandleAlloc().
  2014. Parameters
  2015. hndlp (IN) - the error handle, in most cases, or the environment handle (for
  2016. errors on OCIEnvInit(), OCIHandleAlloc()).
  2017. recordno (IN) - indicates the status record from which the application seeks
  2018. info. Starts from 1.
  2019. sqlstate (OUT) - Not supported in Version 8.0.
  2020. errcodep (OUT) - an ORACLE Error is returned.
  2021. bufp (OUT) - the error message text is returned.
  2022. bufsiz (IN) - the size of the buffer provide to get the error message.
  2023. type (IN) - the type of the handle.
  2024. Related Functions
  2025. OCIHandleAlloc()
  2026. OCIExtractInit
  2027. Name
  2028. OCI Extract Initialize
  2029. Purpose
  2030. This function initializes the parameter manager.
  2031. Syntax
  2032. sword OCIExtractInit(dvoid *hndl, OCIError *err);
  2033. Comments
  2034. It must be called before calling any other parameter manager routine. The NLS
  2035. information is stored inside the parameter manager context and used in
  2036. subsequent calls to OCIExtract routines.
  2037. Returns OCI_SUCCESS, OCI_INVALID_HANDLE, or OCI_ERROR
  2038. Parameters
  2039. hndl (IN/OUT) - The OCI environment or session handle.
  2040. err (IN/OUT) - The OCI error handle. If there is an error, it is recorded in
  2041. err and this function returns OCI_ERROR. Diagnostic information
  2042. can be obtained by calling OCIErrorGet().
  2043. Related Functions
  2044. OCIExtractTerm()
  2045. OCIExtractTerm
  2046. Name
  2047. OCI Extract Terminate
  2048. Purpose
  2049. This function releases all dynamically allocated storage and may perform
  2050. other internal bookkeeping functions.
  2051. Syntax
  2052. sword OCIExtractTerm(dvoid *hndl, OCIError *err);
  2053. Comments
  2054. It must be called when the parameter manager is no longer being used.
  2055. Returns OCI_SUCCESS, OCI_INVALID_HANDLE, or OCI_ERROR
  2056. Parameters
  2057. hndl (IN/OUT) - The OCI environment or session handle.
  2058. err (IN/OUT) - The OCI error handle. If there is an error, it is recorded in
  2059. err and this function returns OCI_ERROR. Diagnostic information
  2060. can be obtained by calling OCIErrorGet().
  2061. Related Functions
  2062. OCIExtractInit()
  2063. OCIExtractReset
  2064. Name
  2065. OCI Extract Reset
  2066. Purpose
  2067. The memory currently used for parameter storage, key definition storage, and
  2068. parameter value lists is freed and the structure is reinitialized.
  2069. Syntax
  2070. sword OCIExtractReset(dvoid *hndl, OCIError *err);
  2071. Comments
  2072. Returns OCI_SUCCESS, OCI_INVALID_HANDLE, or OCI_ERROR
  2073. Parameters
  2074. hndl (IN/OUT) - The OCI environment or session handle.
  2075. err (IN/OUT) - The OCI error handle. If there is an error, it is recorded in
  2076. err and this function returns OCI_ERROR. Diagnostic information
  2077. can be obtained by calling OCIErrorGet().
  2078. Related Functions
  2079. OCIExtractSetNumKeys
  2080. Name
  2081. OCI Extract Set Number of Keys
  2082. Purpose
  2083. Informs the parameter manager of the number of keys that will be registered.
  2084. Syntax
  2085. sword OCIExtractSetNumKeys(dvoid *hndl, OCIError *err, uword numkeys);
  2086. Comments
  2087. This routine must be called prior to the first call of OCIExtractSetKey().
  2088. Returns OCI_SUCCESS, OCI_INVALID_HANDLE, or OCI_ERROR
  2089. Parameters
  2090. hndl (IN/OUT) - The OCI environment or session handle.
  2091. err (IN/OUT) - The OCI error handle. If there is an error, it is recorded in
  2092. err and this function returns OCI_ERROR. Diagnostic information
  2093. can be obtained by calling OCIErrorGet().
  2094. numkeys (IN) - The number of keys that will be registered with
  2095. OCIExtractSetKey().
  2096. Related Functions
  2097. OCIExtractSetKey()
  2098. OCIExtractSetKey
  2099. Name
  2100. OCI Extract Set Key definition
  2101. Purpose
  2102. Registers information about a key with the parameter manager.
  2103. Syntax
  2104. sword OCIExtractSetKey(dvoid *hndl, OCIError *err, CONST OraText *name,
  2105. ub1 type, ub4 flag, CONST dvoid *defval,
  2106. CONST sb4 *intrange, CONST OraText *CONST *strlist);
  2107. Comments
  2108. This routine must be called after calling OCIExtractSetKey() and before
  2109. calling OCIExtractFromFile() or OCIExtractFromStr().
  2110. Returns OCI_SUCCESS, OCI_INVALID_HANDLE, or OCI_ERROR
  2111. Parameters
  2112. hndl (IN/OUT) - The OCI environment or session handle.
  2113. err (IN/OUT) - The OCI error handle. If there is an error, it is recorded in
  2114. err and this function returns OCI_ERROR. Diagnostic information
  2115. can be obtained by calling OCIErrorGet().
  2116. name (IN) - The name of the key.
  2117. type (IN) - The type of the key (OCI_EXTRACT_TYPE_INTEGER,
  2118. OCI_EXTRACT_TYPE_OCINUM, OCI_EXTRACT_TYPE_STRING, or
  2119. OCI_EXTRACT_TYPE_BOOLEAN).
  2120. flag (IN) - Set to OCI_EXTRACT_MULTIPLE if the key can take multiple values
  2121. or 0 otherwise.
  2122. defval (IN) - Set to the default value for the key. May be NULL if there is
  2123. no default. A string default must be a (text*) type, an
  2124. integer default must be an (sb4*) type, and a boolean default
  2125. must be a (ub1*) type.
  2126. intrange (IN) - Starting and ending values for the allowable range of integer
  2127. values. May be NULL if the key is not an integer type or if
  2128. all integer values are acceptable.
  2129. strlist (IN) - List of all acceptable text strings for the key. May be NULL
  2130. if the key is not a string type or if all text values are
  2131. acceptable.
  2132. Related Functions
  2133. OCIExtractSetNumKeys()
  2134. OCIExtractFromFile
  2135. Name
  2136. OCI Extract parameters From File
  2137. Purpose
  2138. The keys and their values in the given file are processed.
  2139. Syntax
  2140. sword OCIExtractFromFile(dvoid *hndl, OCIError *err, ub4 flag,
  2141. OraText *filename);
  2142. Comments
  2143. Returns OCI_SUCCESS, OCI_INVALID_HANDLE, or OCI_ERROR
  2144. Parameters
  2145. hndl (IN/OUT) - The OCI environment or session handle.
  2146. err (IN/OUT) - The OCI error handle. If there is an error, it is recorded in
  2147. err and this function returns OCI_ERROR. Diagnostic information
  2148. can be obtained by calling OCIErrorGet().
  2149. flag (IN) - Zero or has one or more of the following bits set:
  2150. OCI_EXTRACT_CASE_SENSITIVE, OCI_EXTRACT_UNIQUE_ABBREVS, or
  2151. OCI_EXTRACT_APPEND_VALUES.
  2152. filename (IN) - Null-terminated filename string.
  2153. Related Functions
  2154. OCIExtractFromStr
  2155. Name
  2156. OCI Extract parameters From String
  2157. Purpose
  2158. The keys and their values in the given string are processed.
  2159. Syntax
  2160. sword OCIExtractFromStr(dvoid *hndl, OCIError *err, ub4 flag, OraText *input);
  2161. Comments
  2162. Returns OCI_SUCCESS, OCI_INVALID_HANDLE, or OCI_ERROR
  2163. Parameters
  2164. hndl (IN/OUT) - The OCI environment or session handle.
  2165. err (IN/OUT) - The OCI error handle. If there is an error, it is recorded in
  2166. err and this function returns OCI_ERROR. Diagnostic information
  2167. can be obtained by calling OCIErrorGet().
  2168. flag (IN) - Zero or has one or more of the following bits set:
  2169. OCI_EXTRACT_CASE_SENSITIVE, OCI_EXTRACT_UNIQUE_ABBREVS, or
  2170. OCI_EXTRACT_APPEND_VALUES.
  2171. input (IN) - Null-terminated input string.
  2172. Related Functions
  2173. OCIExtractToInt
  2174. Name
  2175. OCI Extract To Integer
  2176. Purpose
  2177. Gets the integer value for the specified key.
  2178. Syntax
  2179. sword OCIExtractToInt(dvoid *hndl, OCIError *err, OraText *keyname,
  2180. uword valno, sb4 *retval);
  2181. Comments
  2182. The valno'th value (starting with 0) is returned.
  2183. Returns OCI_SUCCESS, OCI_INVALID_HANDLE, OCI_NO_DATA, or OCI_ERROR.
  2184. OCI_NO_DATA means that there is no valno'th value for this key.
  2185. Parameters
  2186. hndl (IN) - The OCI environment or session handle.
  2187. err (IN/OUT) - The OCI error handle. If there is an error, it is recorded in
  2188. err and this function returns OCI_ERROR. Diagnostic information
  2189. can be obtained by calling OCIErrorGet().
  2190. keyname (IN) - Key name.
  2191. valno (IN) - Which value to get for this key.
  2192. retval (OUT) - The actual integer value.
  2193. Related Functions
  2194. OCIExtractToBool
  2195. Name
  2196. OCI Extract To Boolean
  2197. Purpose
  2198. Gets the boolean value for the specified key.
  2199. Syntax
  2200. sword OCIExtractToBool(dvoid *hndl, OCIError *err, OraText *keyname,
  2201. uword valno, ub1 *retval);
  2202. Comments
  2203. The valno'th value (starting with 0) is returned.
  2204. Returns OCI_SUCCESS, OCI_INVALID_HANDLE, OCI_NO_DATA, or OCI_ERROR.
  2205. OCI_NO_DATA means that there is no valno'th value for this key.
  2206. Parameters
  2207. hndl (IN) - The OCI environment or session handle.
  2208. err (IN/OUT) - The OCI error handle. If there is an error, it is recorded in
  2209. err and this function returns OCI_ERROR. Diagnostic information
  2210. can be obtained by calling OCIErrorGet().
  2211. keyname (IN) - Key name.
  2212. valno (IN) - Which value to get for this key.
  2213. retval (OUT) - The actual boolean value.
  2214. Related Functions
  2215. OCIExtractToStr
  2216. Name
  2217. OCI Extract To String
  2218. Purpose
  2219. Gets the string value for the specified key.
  2220. Syntax
  2221. sword OCIExtractToStr(dvoid *hndl, OCIError *err, OraText *keyname,
  2222. uword valno, OraText *retval, uword buflen);
  2223. Comments
  2224. The valno'th value (starting with 0) is returned.
  2225. Returns OCI_SUCCESS, OCI_INVALID_HANDLE, OCI_NO_DATA, or OCI_ERROR.
  2226. OCI_NO_DATA means that there is no valno'th value for this key.
  2227. Parameters
  2228. hndl (IN) - The OCI environment or session handle.
  2229. err (IN/OUT) - The OCI error handle. If there is an error, it is recorded in
  2230. err and this function returns OCI_ERROR. Diagnostic information
  2231. can be obtained by calling OCIErrorGet().
  2232. keyname (IN) - Key name.
  2233. valno (IN) - Which value to get for this key.
  2234. retval (OUT) - The actual null-terminated string value.
  2235. buflen (IN) - The length of the buffer for retval.
  2236. Related Functions
  2237. Note: The following OCIExtract functions are unavailable in this release
  2238. OCIExtractToOCINum
  2239. Name
  2240. OCI Extract To OCI Number
  2241. Purpose
  2242. Gets the OCINumber value for the specified key.
  2243. Syntax
  2244. sword OCIExtractToOCINum(dvoid *hndl, OCIError *err, OraText *keyname,
  2245. uword valno, OCINumber *retval);
  2246. Comments
  2247. The valno'th value (starting with 0) is returned.
  2248. Returns OCI_SUCCESS, OCI_INVALID_HANDLE, OCI_NO_DATA, or OCI_ERROR.
  2249. OCI_NO_DATA means that there is no valno'th value for this key.
  2250. Parameters
  2251. hndl (IN) - The OCI environment or session handle.
  2252. err (IN/OUT) - The OCI error handle. If there is an error, it is recorded in
  2253. err and this function returns OCI_ERROR. Diagnostic information
  2254. can be obtained by calling OCIErrorGet().
  2255. keyname (IN) - Key name.
  2256. valno (IN) - Which value to get for this key.
  2257. retval (OUT) - The actual OCINumber value.
  2258. Related Functions
  2259. OCIExtractToList
  2260. Name
  2261. OCI Extract To parameter List
  2262. Purpose
  2263. Generates a list of parameters from the parameter structures that are stored
  2264. in memory.
  2265. Syntax
  2266. sword OCIExtractToList(dvoid *hndl, OCIError *err, uword *numkeys);
  2267. Comments
  2268. Must be called before OCIExtractValues() is called.
  2269. Returns OCI_SUCCESS, OCI_INVALID_HANDLE, or OCI_ERROR
  2270. Parameters
  2271. hndl (IN) - The OCI environment or session handle.
  2272. err (IN/OUT) - The OCI error handle. If there is an error, it is recorded in
  2273. err and this function returns OCI_ERROR. Diagnostic information
  2274. can be obtained by calling OCIErrorGet().
  2275. numkeys (OUT) - Number of distinct keys stored in memory.
  2276. Related Functions
  2277. OCIExtractFromList()
  2278. OCIExtractFromList
  2279. Name
  2280. OCI Extract From parameter List
  2281. Purpose
  2282. Generates a list of values for the a parameter in the parameter list.
  2283. Syntax
  2284. sword OCIExtractFromList(dvoid *hndl, OCIError *err, uword index,
  2285. OraText *name, ub1 *type, uword *numvals,
  2286. dvoid ***values);
  2287. Comments
  2288. Parameters are specified by an index. OCIExtractToList() must be called prior
  2289. to calling this routine to generate the parameter list from the parameter
  2290. structures that are stored in memory.
  2291. Returns OCI_SUCCESS, OCI_INVALID_HANDLE, or OCI_ERROR
  2292. Parameters
  2293. hndl (IN) - The OCI environment or session handle.
  2294. err (IN/OUT) - The OCI error handle. If there is an error, it is recorded in
  2295. err and this function returns OCI_ERROR. Diagnostic information
  2296. can be obtained by calling OCIErrorGet().
  2297. name (OUT) - Name of the key for the current parameter.
  2298. type (OUT) - Type of the current parameter (OCI_EXTRACT_TYPE_STRING,
  2299. OCI_EXTRACT_TYPE_INTEGER, OCI_EXTRACT_TYPE_OCINUM, or
  2300. OCI_EXTRACT_TYPE_BOOLEAN)
  2301. numvals (OUT) - Number of values for this parameter.
  2302. values (OUT) - The values for this parameter.
  2303. Related Functions
  2304. OCIExtractToList()
  2305. ************************ OCIFileClose() ***********************************
  2306. Name
  2307. OCIFileClose - Oracle Call Interface FILE i/o CLOSE
  2308. Purpose
  2309. Close a previously opened file.
  2310. Syntax
  2311. sword OCIFileClose ( dvoid *hndl,
  2312. OCIError *err,
  2313. OCIFileObject *filep )
  2314. Comments
  2315. This function will close a previously opened file. If the function succeeds
  2316. then OCI_SUCCESS will be returned, else OCI_ERROR.
  2317. Parameters
  2318. hndl (IN) - the OCI environment or session handle.
  2319. err (OUT) - the OCI error handle
  2320. filep (IN) - the OCIFile file object
  2321. Related Functions
  2322. OCIFileOpen.
  2323. ********************* OCIFileExists() **************************************
  2324. Name
  2325. OCIFileExists - Oracle Call Interface FILE i/o EXIST
  2326. Purpose
  2327. Check to see if the file exists.
  2328. Syntax
  2329. sword OCIFileExists ( dvoid *hndl,
  2330. OCIError *err,
  2331. OraText *filename,
  2332. OraText *path,
  2333. ub1 *flag )
  2334. Comments
  2335. This function will set the flag to TRUE if the file exists else it will
  2336. be set to FALSE.
  2337. The function will return OCI_ERROR if any error is encountered, else
  2338. it will return OCI_ERROR.
  2339. Parameters
  2340. hndl(IN) - OCI environment or session handle
  2341. err(OUT) - OCI error handle
  2342. filename(IN) - filename
  2343. path(IN) - path of the file
  2344. flag(OUT) - whether the file exists or not
  2345. Related Functions.
  2346. None.
  2347. **************************** OCIFileFlush() ******************************
  2348. Name
  2349. OCIFileFlush - Oracle Call Interface File i/o FLUSH
  2350. Purpose
  2351. Flush the buffers associated with the file to the disk.
  2352. Syntax
  2353. sword OCIFileFlush ( dvoid *hndl,
  2354. OCIError *err,
  2355. OCIFileObject *filep )
  2356. Comments
  2357. The function will return OCI_ERROR if any error is encountered, else
  2358. it will return OCI_ERROR.
  2359. Parameters
  2360. hndl (IN) - the OCI environment or session handle.
  2361. err (OUT) - the OCI error handle
  2362. filep (IN) - the OCIFile file object
  2363. Related Functions
  2364. OCIFileOpen, OCIFileWrite
  2365. *************************** OCIFileGetLength() ****************************
  2366. Name
  2367. OCIFileGetLength - Oracle Call Interface FILE i/o GET file LENGTH
  2368. Purpose
  2369. Get the length of a file.
  2370. Syntax
  2371. OCIFileGetLength(dvoid *hndl,
  2372. OCIError *err,
  2373. OraText *filename,
  2374. OraText *path,
  2375. ubig_ora *lenp )
  2376. Comments
  2377. The length of the file will be returned in lenp.
  2378. The function will return OCI_ERROR if any error is encountered, else
  2379. it will return OCI_ERROR.
  2380. Parameters
  2381. hndl (IN) - the OCI environment or session handle.
  2382. err (OUT) - the OCI error handle. If there is an error, it is recorded
  2383. in err and this function returns OCI_ERROR. Diagnostic information can be
  2384. obtained by calling OCIErrorGet().
  2385. filename (IN) - file name.
  2386. path (IN) - path of the file.
  2387. lenp (OUT) - On output, it is the length of the file in bytes.
  2388. is the number of bytes in the file.
  2389. Related Functions
  2390. None.
  2391. ******************************** OCIFileInit() *****************************
  2392. Name
  2393. OCIFileInit - Oracle Call Interface FILE i/o INITialize
  2394. Purpose
  2395. Initialize the OCI File I/O package and create the OCIFile context.
  2396. Syntax
  2397. sword OCIFileInit ( dvoid *hndl,
  2398. OCIError *err)
  2399. Comments
  2400. This function should be called before any of the OCIFile functions are
  2401. used.
  2402. The function will return OCI_ERROR if any error is encountered, else
  2403. it will return OCI_ERROR.
  2404. Parameters
  2405. hndl(IN) - OCI environment or session handle.
  2406. err(OUT) - OCI error structure.
  2407. Related Functions
  2408. OCIFileTerm
  2409. ********************************* OCIFileOpen() *****************************
  2410. Name
  2411. OCIFileOpen - Oracle Call Interface File i/o OPEN
  2412. Purpose
  2413. Open a file.
  2414. Syntax
  2415. sword OCIFileOpen ( dvoid *hndl,
  2416. OCIError *err,
  2417. OCIFileObject **filep,
  2418. OraText *filename,
  2419. OraText *path,
  2420. ub4 mode,
  2421. ub4 create,
  2422. ub4 type )
  2423. Comments
  2424. OCIFileOpen returns a handle to the open file in filep if the file is
  2425. successfully opened.
  2426. If one wants to use the standard file objects (stdin, stdout & stderr)
  2427. then OCIFileOpen whould be called with the type filed containing the
  2428. appropriate type (see the parameter type). If any of the standard files
  2429. are specified then filename, path, mode and create are ignored.
  2430. The function will return OCI_ERROR if any error is encountered, else
  2431. it will return OCI_ERROR.
  2432. Parameters
  2433. hndl (OUT) - the OCI environment or session handle.
  2434. err (OUT) - the OCI error handle. If there is an error, it is recorded
  2435. in err and this function returns OCI_ERROR. Diagnostic information can be
  2436. obtained by calling OCIErrorGet().
  2437. filep (OUT) - the file object to be returned.
  2438. filename (IN) - file name (NULL terminated string).
  2439. path (IN) - path of the file (NULL terminated string).
  2440. mode - mode in which to open the file (valid modes are OCI_FILE_READONLY,
  2441. OCI_FILE_WRITEONLY, OCI_FILE_READ_WRITE).
  2442. create - should the file be created if it does not exist. Valid values
  2443. are:
  2444. OCI_FILE_TRUNCATE - create a file regardless of whether or not it exists.
  2445. If the file already exists overwrite it.
  2446. OCI_FILE_EXIST - open it if it exists, else fail.
  2447. OCI_FILE_EXCL - fail if the file exists, else create.
  2448. OCI_FILE_CREATE - open the file if it exists, and create it if it doesn't.
  2449. OCI_FILE_APPEND - set the file pointer to the end of the file prior to
  2450. writing(this flag can be OR'ed with OCI_FILE_EXIST or
  2451. OCI_FILE_CREATE).
  2452. type - file type. Valid values are OCI_FILE_TEXT, OCI_FILE_BIN,
  2453. OCI_FILE_STDIN, OCI_FILE_STDOUT and OCI_FILE_STDERR.
  2454. If any of the standard files are specified then filename, path, mode
  2455. and create are ignored.
  2456. Related Functions.
  2457. OCIFileClose
  2458. ************************** OCIFileRead() ************************************
  2459. Name
  2460. OCIFileRead - Oracle Call Interface FILE i/o READ
  2461. Purpose
  2462. Read from a file into a buffer.
  2463. Syntax
  2464. sword OCIFileRead ( dvoid *hndl,
  2465. OCIError *err,
  2466. OCIFileObject *filep,
  2467. dvoid *bufp,
  2468. ub4 bufl,
  2469. ub4 *bytesread )
  2470. Comments
  2471. Upto bufl bytes from the file will be read into bufp. The user should
  2472. allocate memory for the buffer.
  2473. The number of bytes read would be in bytesread.
  2474. The function will return OCI_ERROR if any error is encountered, else
  2475. it will return OCI_ERROR.
  2476. Parameters
  2477. hndl (IN) - the OCI environment or session handle.
  2478. err (OUT) - the OCI error handle. If there is an error, it is recorded
  2479. in err and this function returns OCI_ERROR. Diagnostic information can be
  2480. obtained by calling OCIErrorGet().
  2481. filep (IN/OUT) - a File Object that uniquely references the file.
  2482. bufp (IN) - the pointer to a buffer into which the data will be read. The
  2483. length of the allocated memory is assumed to be bufl.
  2484. bufl - the length of the buffer in bytes.
  2485. bytesread (OUT) - the number of bytes read.
  2486. Related Functions
  2487. OCIFileOpen, OCIFileSeek, OCIFileWrite
  2488. ****************************** OCIFileSeek() ******************************
  2489. Name
  2490. OCIFileSeek - Oracle Call Interface FILE i/o SEEK
  2491. Purpose
  2492. Perfom a seek to a byte position.
  2493. Syntax
  2494. sword OCIFileSeek ( dvoid *hndl,
  2495. OCIError *err,
  2496. OCIFileObject *filep,
  2497. uword origin,
  2498. ubig_ora offset,
  2499. sb1 dir)
  2500. Comments
  2501. The function will return OCI_ERROR if any error is encountered, else
  2502. it will return OCI_ERROR.
  2503. Parameters
  2504. hndl (IN) - the OCI environment or session handle.
  2505. err (OUT) - the OCI error handle. If there is an error, it is recorded
  2506. in err and this function returns OCI_ERROR. Diagnostic information can be
  2507. obtained by calling OCIErrorGet().
  2508. filep (IN/OUT) - a file handle that uniquely references the file.
  2509. origin - The starting point we want to seek from. NOTE: The starting
  2510. point may be OCI_FILE_SEEK_BEGINNING (beginning), OCI_FILE_SEEK_CURRENT
  2511. (current position), or OCI_FILE_SEEK_END (end of file).
  2512. offset - The number of bytes from the origin we want to start reading from.
  2513. dir - The direction we want to go from the origin. NOTE: The direction
  2514. can be either OCI_FILE_FORWARD or OCI_FILE_BACKWARD.
  2515. Related Function
  2516. OCIFileOpen, OCIFileRead, OCIFileWrite
  2517. *************************** OCIFileTerm() **********************************
  2518. Name
  2519. OCIFileTerm - Oracle Call Interface FILE i/o TERMinate
  2520. Purpose
  2521. Terminate the OCI File I/O package and destroy the OCI File context.
  2522. Syntax
  2523. sword OCIFileTerm ( dvoid *hndl,
  2524. OCIError *err )
  2525. Comments
  2526. After this function has been called no OCIFile function should be used.
  2527. The function will return OCI_ERROR if any error is encountered, else
  2528. it will return OCI_ERROR.
  2529. Parameters
  2530. hndl(IN) - OCI environment or session handle.
  2531. err(OUT) - OCI error structure.
  2532. Related Functions
  2533. OCIFileInit
  2534. ********************************* OCIFileWrite() ****************************
  2535. Name
  2536. OCIFileWrite - Oracle Call Interface FILE i/o WRITE
  2537. Purpose
  2538. Write data from buffer into a file.
  2539. Syntax
  2540. sword OCIFileWrite ( dvoid *hndl,
  2541. OCIError *err,
  2542. OCIFileObject *filep,
  2543. dvoid *bufp,
  2544. ub4 buflen
  2545. ub4 *byteswritten )
  2546. Comments
  2547. The number of bytes written will be in *byteswritten.
  2548. The function will return OCI_ERROR if any error is encountered, else
  2549. it will return OCI_ERROR.
  2550. Parameters
  2551. hndl (IN) - the OCI environment or session handle.
  2552. err (OUT) - the OCI error handle. If there is an error, it is recorded
  2553. in err and this function returns OCI_ERROR. Diagnostic information can be
  2554. obtained by calling OCIErrorGet().
  2555. filep (IN/OUT) - a file handle that uniquely references the file.
  2556. bufp (IN) - the pointer to a buffer from which the data will be written.
  2557. The length of the allocated memory is assumed to be the value passed
  2558. in bufl.
  2559. bufl - the length of the buffer in bytes.
  2560. byteswritten (OUT) - the number of bytes written.
  2561. Related Functions
  2562. OCIFileOpen, OCIFileSeek, OCIFileRead
  2563. OCIHandleAlloc()
  2564. Name
  2565. OCI Get HaNDLe
  2566. Purpose
  2567. This call returns a pointer to an allocated and initialized handle.
  2568. Syntax
  2569. sword OCIHandleAlloc ( CONST dvoid *parenth,
  2570. dvoid **hndlpp,
  2571. ub4 type,
  2572. size_t xtramem_sz,
  2573. dvoid **usrmempp);
  2574. Comments
  2575. Returns a pointer to an allocated and initialized structure, corresponding to
  2576. the type specified in type. A non-NULL handle is returned on success. Bind
  2577. handle and define handles are allocated with respect to a statement handle. All
  2578. other handles are allocated with respect to an environment handle which is
  2579. passed in as a parent handle.
  2580. No diagnostics are available on error. This call returns OCI_SUCCESS if
  2581. successful, or OCI_INVALID_HANDLE if an out-of-memory error occurs.
  2582. Handles must be allocated using OCIHandleAlloc() before they can be passed
  2583. into an OCI call.
  2584. Parameters
  2585. parenth (IN) - an environment or a statement handle.
  2586. hndlpp (OUT) - returns a handle to a handle type.
  2587. type (IN) - specifies the type of handle to be allocated. The specific types
  2588. are:
  2589. OCI_HTYPE_ERROR - specifies generation of an error report handle of
  2590. C type OCIError
  2591. OCI_HTYPE_SVCCTX - specifies generation of a service context handle
  2592. of C type OCISvcCtx
  2593. OCI_HTYPE_STMT - specifies generation of a statement (application
  2594. request) handle of C type OCIStmt
  2595. OCI_HTYPE_BIND - specifies generation of a bind information handle
  2596. of C type OCIBind
  2597. OCI_HTYPE_DEFINE - specifies generation of a column definition
  2598. handle of C type OCIDefine
  2599. OCI_HTYPE_DESCRIBE - specifies generation of a select list
  2600. description handle of C type OCIDesc
  2601. OCI_HTYPE_SERVER - specifies generation of a server context handle
  2602. of C type OCIServer
  2603. OCI_HTYPE_SESSION - specifies generation of an authentication
  2604. context handle of C type OCISession
  2605. OCI_HTYPE_TRANS - specifies generation of a transaction context
  2606. handle of C type OCITrans
  2607. OCI_HTYPE_COMPLEXOBJECT - specifies generation of a complex
  2608. object retrieval handle of C type OCIComplexObject
  2609. OCI_HTYPE_SECURITY - specifies generation of a security handle of C
  2610. type OCISecurity
  2611. xtramem_sz (IN) - specifies an amount of user memory to be allocated.
  2612. usrmempp (OUT) - returns a pointer to the user memory of size xtramemsz
  2613. allocated by the call for the user.
  2614. Related Functions
  2615. OCIHandleFree()
  2616. OCIHandleFree()
  2617. Name
  2618. OCI Free HaNDLe
  2619. Purpose
  2620. This call explicitly deallocates a handle.
  2621. Syntax
  2622. sword OCIHandleFree ( dvoid *hndlp,
  2623. ub4 type);
  2624. Comments
  2625. This call frees up storage associated with a handle, corresponding to the type
  2626. specified in the type parameter.
  2627. This call returns either OCI_SUCCESS or OCI_INVALID_HANDLE.
  2628. All handles must be explicitly deallocated. OCI will not deallocate a child
  2629. handle if the parent is deallocated.
  2630. Parameters
  2631. hndlp (IN) - an opaque pointer to some storage.
  2632. type (IN) - specifies the type of storage to be allocated. The specific types
  2633. are:
  2634. OCI_HTYPE_ENV - an environment handle
  2635. OCI_HTYPE_ERROR - an error report handle
  2636. OCI_HTYPE_SVCCTX - a service context handle
  2637. OCI_HTYPE_STMT - a statement (application request) handle
  2638. OCI_HTYPE_BIND - a bind information handle
  2639. OCI_HTYPE_DEFINE - a column definition handle
  2640. OCI_HTYPE_DESCRIBE - a select list description handle
  2641. OCI_HTYPE_SERVER - a server handle
  2642. OCI_HTYPE_SESSION - a user authentication handle
  2643. OCI_HTYPE_TRANS - a transaction handle
  2644. OCI_HTYPE_COMPLEXOBJECT - a complex object retrieval handle
  2645. OCI_HTYPE_SECURITY - a security handle
  2646. Related Functions
  2647. OCIHandleAlloc()
  2648. OCIInitialize()
  2649. Name
  2650. OCI Process Initialize
  2651. Purpose
  2652. Initializes the OCI process environment.
  2653. Syntax
  2654. sword OCIInitialize ( ub4 mode,
  2655. CONST dvoid *ctxp,
  2656. CONST dvoid *(*malocfp)
  2657. ( dvoid *ctxp,
  2658. size_t size ),
  2659. CONST dvoid *(*ralocfp)
  2660. ( dvoid *ctxp,
  2661. dvoid *memp,
  2662. size_t newsize ),
  2663. CONST void (*mfreefp)
  2664. ( dvoid *ctxp,
  2665. dvoid *memptr ));
  2666. Comments
  2667. This call initializes the OCI process environment.
  2668. OCIInitialize() must be invoked before any other OCI call.
  2669. Parameters
  2670. mode (IN) - specifies initialization of the mode. The valid modes are:
  2671. OCI_DEFAULT - default mode.
  2672. OCI_THREADED - threaded environment. In this mode, internal data
  2673. structures are protected from concurrent accesses by multiple threads.
  2674. OCI_OBJECT - will use navigational object interface.
  2675. ctxp (IN) - user defined context for the memory call back routines.
  2676. malocfp (IN) - user-defined memory allocation function. If mode is
  2677. OCI_THREADED, this memory allocation routine must be thread safe.
  2678. ctxp - context pointer for the user-defined memory allocation function.
  2679. size - size of memory to be allocated by the user-defined memory
  2680. allocation function
  2681. ralocfp (IN) - user-defined memory re-allocation function. If mode is
  2682. OCI_THREADED, this memory allocation routine must be thread safe.
  2683. ctxp - context pointer for the user-defined memory reallocation
  2684. function.
  2685. memp - pointer to memory block
  2686. newsize - new size of memory to be allocated
  2687. mfreefp (IN) - user-defined memory free function. If mode is
  2688. OCI_THREADED, this memory free routine must be thread safe.
  2689. ctxp - context pointer for the user-defined memory free function.
  2690. memptr - pointer to memory to be freed
  2691. Example
  2692. See the description of OCIStmtPrepare() on page 13-96 for an example showing
  2693. the use of OCIInitialize().
  2694. Related Functions
  2695. -------------------------------OCITerminate------------------------------------
  2696. OCITerminate()
  2697. Name
  2698. OCI process Terminate
  2699. Purpose
  2700. Do cleanup before process termination
  2701. Syntax
  2702. sword OCITerminate (ub4 mode);
  2703. Comments
  2704. This call performs OCI related clean up before the OCI process terminates.
  2705. If the process is running in shared mode then the OCI process is disconnected
  2706. from the shared memory subsystem.
  2707. OCITerminate() should be the last OCI call in any process.
  2708. Parameters
  2709. mode (IN) - specifies different termination modes.
  2710. OCI_DEFAULT - default mode.
  2711. Example
  2712. Related Functions
  2713. OCIInitialize()
  2714. ------------------------ OCIAppCtxSet--------------------------------------
  2715. Name
  2716. OCI Application context Set
  2717. Purpose
  2718. Set an attribute and its value for a particular application context
  2719. namespace
  2720. Syntax
  2721. (sword) OCIAppCtxSet((void *) sesshndl, (dvoid *)nsptr,(ub4) nsptrlen,
  2722. (dvoid *)attrptr, (ub4) attrptrlen, (dvoid *)valueptr,
  2723. (ub4) valueptrlen, errhp, (ub4)mode);
  2724. Comments
  2725. Please note that the information set on the session handle is sent to the server during the next OCIStatementExecute or OCISessionBegin.
  2726. This information is cleared from the session handle, once the information
  2727. has been sent over to the server,and should be setup again if needed.
  2728. Parameters
  2729. sesshndl (IN/OUT) - Pointer to a session handle
  2730. nsptr (IN) - Pointer to namespace string
  2731. nsptrlen (IN) - length of the nsptr
  2732. attrptr (IN) - Pointer to attribute string
  2733. attrptrlen (IN) - length of the attrptr
  2734. valueptr (IN) - Pointer to value string
  2735. valueptrlen(IN) - length of the valueptr
  2736. errhp (OUT) - Error from the API
  2737. mode (IN) - mode of operation (OCI_DEFAULT)
  2738. Returns
  2739. error if any
  2740. Example
  2741. Related Functions
  2742. OCIAppCtxClearAll
  2743. ------------------------ OCIAppCtxClearAll---------------------------------
  2744. Name
  2745. OCI Application Context Clear all attributes in a namespace
  2746. Purpose
  2747. To clear the values all attributes in a namespace
  2748. Syntax
  2749. (sword) OCIAppCtxClearAll((void *) sesshndl, (dvoid *)nsptr, (ub4) nsptrlen,
  2750. (OCIError *)errhp, (ub4)mode);
  2751. Comments
  2752. This will clean up the context information on the server side during the next piggy-back to the server.
  2753. Parameters
  2754. sesshndl (IN/OUT) - Pointer to a session handle
  2755. nsptr (IN) - Pointer to namespace string where the values of all
  2756. attributes are cleared
  2757. nsptrlen (IN) - length of the nsptr
  2758. errhp (OUT) - Error from the API
  2759. mode (IN) - mode of operation (OCI_DEFAULT)
  2760. Example
  2761. Returns
  2762. error if any
  2763. Related Functions
  2764. OCIAppCtxSet
  2765. ---------------------- OCIIntervalAssign ---------------------------------
  2766. sword OCIIntervalAssign(dvoid *hndl, OCIError *err,
  2767. CONST OCIInterval *inpinter, OCIInterval *outinter );
  2768. DESCRIPTION
  2769. Copies one interval to another to create a replica
  2770. PARAMETERS
  2771. hndl (IN) - Session/Env handle.
  2772. err (IN/OUT) - error handle. If there is an error, it is
  2773. recorded in 'err' and this function returns OCI_ERROR.
  2774. The error recorded in 'err' can be retrieved by calling
  2775. OCIErrorGet().
  2776. (IN) inpinter - Input Interval
  2777. (OUT) outinter - Output Interval
  2778. RETURNS
  2779. OCI_INVALID_HANDLE if 'err' is NULL.
  2780. OCI_SUCCESS otherwise
  2781. ---------------------- OCIIntervalCheck ------------------------------------
  2782. sword OCIIntervalCheck(dvoid *hndl, OCIError *err, CONST OCIInterval *interval,
  2783. ub4 *valid );
  2784. DESCRIPTION
  2785. Checks the validity of an interval
  2786. PARAMETERS
  2787. hndl (IN) - Session/Env handle.
  2788. err (IN/OUT) - error handle. If there is an error, it is
  2789. recorded in 'err' and this function returns OCI_ERROR.
  2790. The error recorded in 'err' can be retrieved by calling
  2791. OCIErrorGet().
  2792. (IN) interval - Interval to be checked
  2793. (OUT) valid - Zero if the interval is valid, else returns an Ored
  2794. combination of the following codes.
  2795. Macro name Bit number Error
  2796. ---------- ---------- -----
  2797. OCI_INTER_INVALID_DAY 0x1 Bad day
  2798. OCI_INTER_DAY_BELOW_VALID 0x2 Bad DAy Low/high bit (1=low)
  2799. OCI_INTER_INVALID_MONTH 0x4 Bad MOnth
  2800. OCI_INTER_MONTH_BELOW_VALID 0x8 Bad MOnth Low/high bit (1=low)
  2801. OCI_INTER_INVALID_YEAR 0x10 Bad YeaR
  2802. OCI_INTER_YEAR_BELOW_VALID 0x20 Bad YeaR Low/high bit (1=low)
  2803. OCI_INTER_INVALID_HOUR 0x40 Bad HouR
  2804. OCI_INTER_HOUR_BELOW_VALID 0x80 Bad HouR Low/high bit (1=low)
  2805. OCI_INTER_INVALID_MINUTE 0x100 Bad MiNute
  2806. OCI_INTER_MINUTE_BELOW_VALID 0x200 Bad MiNute Low/high bit(1=low)
  2807. OCI_INTER_INVALID_SECOND 0x400 Bad SeCond
  2808. OCI_INTER_SECOND_BELOW_VALID 0x800 bad second Low/high bit(1=low)
  2809. OCI_INTER_INVALID_FRACSEC 0x1000 Bad Fractional second
  2810. OCI_INTER_FRACSEC_BELOW_VALID 0x2000 Bad fractional second Low/High
  2811. RETURNS
  2812. OCI_SUCCESS if interval is okay
  2813. OCI_INVALID_HANDLE if 'err' is NULL.
  2814. ---------------------- OCIIntervalCompare -----------------------------------
  2815. sword OCIIntervalCompare(dvoid *hndl, OCIError *err, OCIInterval *inter1,
  2816. OCIInterval *inter2, sword *result );
  2817. DESCRIPTION
  2818. Compares two intervals, returns 0 if equal, -1 if inter1 < inter2,
  2819. 1 if inter1 > inter2
  2820. PARAMETERS
  2821. hndl (IN) - Session/Env handle.
  2822. err (IN/OUT) - error handle. If there is an error, it is
  2823. recorded in 'err' and this function returns OCI_ERROR.
  2824. The error recorded in 'err' can be retrieved by calling
  2825. OCIErrorGet().
  2826. inter1 (IN) - Interval to be compared
  2827. inter2 (IN) - Interval to be compared
  2828. result (OUT) - comparison result, 0 if equal, -1 if inter1 < inter2,
  2829. 1 if inter1 > inter2
  2830. RETURNS
  2831. OCI_SUCCESS on success
  2832. OCI_INVALID_HANDLE if 'err' is NULL.
  2833. OCI_ERROR if
  2834. the two input datetimes are not mutually comparable.
  2835. ---------------------- OCIIntervalDivide ------------------------------------
  2836. sword OCIIntervalDivide(dvoid *hndl, OCIError *err, OCIInterval *dividend,
  2837. OCINumber *divisor, OCIInterval *result );
  2838. DESCRIPTION
  2839. Divides an interval by an Oracle Number to produce an interval
  2840. PARAMETERS
  2841. hndl (IN) - Session/Env handle.
  2842. err (IN/OUT) - error handle. If there is an error, it is
  2843. recorded in 'err' and this function returns OCI_ERROR.
  2844. The error recorded in 'err' can be retrieved by calling
  2845. OCIErrorGet().
  2846. dividend (IN) - Interval to be divided
  2847. divisor (IN) - Oracle Number dividing `dividend'
  2848. result (OUT) - resulting interval (dividend / divisor)
  2849. RETURNS
  2850. OCI_SUCCESS on success
  2851. OCI_INVALID_HANDLE if 'err' is NULL.
  2852. ---------------------- OCIIntervalFromNumber --------------------
  2853. sword OCIIntervalFromNumber(dvoid *hndl, OCIError *err,
  2854. OCIInterval *inter, OCINumber *number);
  2855. DESCRIPTION
  2856. Converts an interval to an Oracle Number
  2857. PARAMETERS
  2858. hndl (IN) - Session/Env handle.
  2859. err (IN/OUT) - error handle. If there is an error, it is
  2860. recorded in 'err' and this function returns OCI_ERROR.
  2861. The error recorded in 'err' can be retrieved by calling
  2862. OCIErrorGet().
  2863. (OUT) interval - Interval to be converted
  2864. (IN) number - Oracle number result (in years for YEARMONTH interval
  2865. and in days for DAYSECOND)
  2866. RETURNS
  2867. OCI_SUCCESS on success
  2868. OCI_INVALID_HANDLE if 'err' is NULL.
  2869. OCI_ERROR on error.
  2870. NOTES
  2871. Fractional portions of the date (for instance, minutes and seconds if
  2872. the unit chosen is hours) will be included in the Oracle number produced.
  2873. Excess precision will be truncated.
  2874. ---------------------- OCIIntervalFromText ---------------------------------
  2875. sword OCIIntervalFromText( dvoid *hndl, OCIError *err, CONST OraText *inpstr,
  2876. size_t str_len, OCIInterval *result );
  2877. DESCRIPTION
  2878. Given an interval string produce the interval represented by the string.
  2879. The type of the interval is the type of the 'result' descriptor.
  2880. PARAMETERS
  2881. hndl (IN) - Session/Env handle.
  2882. err (IN/OUT) - error handle. If there is an error, it is
  2883. recorded in 'err' and this function returns OCI_ERROR.
  2884. The error recorded in 'err' can be retrieved by calling
  2885. OCIErrorGet().
  2886. (IN) inpstr - Input string
  2887. (IN) str_len - Length of input string
  2888. (OUT) result - Resultant interval
  2889. RETURNS
  2890. OCI_SUCCESS on success
  2891. OCI_INVALID_HANDLE if 'err' is NULL.
  2892. OCI_ERROR if
  2893. there are too many fields in the literal string
  2894. the year is out of range (-4713 to 9999)
  2895. if the month is out of range (1 to 12)
  2896. if the day of month is out of range (1 to 28...31)
  2897. if hour is not in range (0 to 23)
  2898. if hour is not in range (0 to 11)
  2899. if minute is not in range (0 to 59)
  2900. if seconds in minute not in range (0 to 59)
  2901. if seconds in day not in range (0 to 86399)
  2902. if the interval is invalid
  2903. ---------------------- OCIIntervalGetDaySecond --------------------
  2904. DESCRIPTION
  2905. Gets values of day second interval
  2906. PARAMETERS
  2907. hndl (IN) - Session/Env handle.
  2908. err (IN/OUT) - error handle. If there is an error, it is
  2909. recorded in 'err' and this function returns OCI_ERROR.
  2910. The error recorded in 'err' can be retrieved by calling
  2911. OCIErrorGet().
  2912. day (OUT) - number of days
  2913. hour (OUT) - number of hours
  2914. min (OUT) - number of mins
  2915. sec (OUT) - number of secs
  2916. fsec (OUT) - number of fractional seconds
  2917. result (IN) - resulting interval
  2918. RETURNS
  2919. OCI_SUCCESS on success
  2920. OCI_INVALID_HANDLE if 'err' is NULL.
  2921. ---------------------- OCIIntervalGetYearMonth --------------------
  2922. DESCRIPTION
  2923. Gets year month from an interval
  2924. PARAMETERS
  2925. hndl (IN) - Session/Env handle.
  2926. err (IN/OUT) - error handle. If there is an error, it is
  2927. recorded in 'err' and this function returns OCI_ERROR.
  2928. The error recorded in 'err' can be retrieved by calling
  2929. OCIErrorGet().
  2930. year (OUT) - year value
  2931. month (OUT) - month value
  2932. result (IN) - resulting interval
  2933. RETURNS
  2934. OCI_SUCCESS on success
  2935. OCI_INVALID_HANDLE if 'err' is NULL.
  2936. -------------------------- OCIIntervalAdd ------------------------------
  2937. sword OCIIntervalAdd(dvoid *hndl, OCIError *err, OCIInterval *addend1,
  2938. OCIInterval *addend2, OCIInterval *result );
  2939. NAME OCIIntervalAdd - Adds two intervals
  2940. PARAMETERS
  2941. hndl (IN) - Session/Env handle.
  2942. err (IN/OUT) - error handle. If there is an error, it is
  2943. recorded in 'err' and this function returns OCI_ERROR.
  2944. The error recorded in 'err' can be retrieved by calling
  2945. OCIErrorGet().
  2946. addend1 (IN) - Interval to be added
  2947. addend2 (IN) - Interval to be added
  2948. result (OUT) - resulting interval (addend1 + addend2)
  2949. DESCRIPTION
  2950. Adds two intervals to produce a resulting interval
  2951. RETURNS
  2952. OCI_SUCCESS on success
  2953. OCI_ERROR if:
  2954. the two input intervals are not mutually comparable.
  2955. the resulting year would go above SB4MAXVAL
  2956. the resulting year would go below SB4MINVAL
  2957. OCI_INVALID_HANDLE if 'err' is NULL.
  2958. NOTES
  2959. The two input intervals must be mutually comparable
  2960. ---------------------- OCIIntervalSubtract -------------------------------
  2961. sword OCIIntervalSubtract(dvoid *hndl, OCIError *err, OCIInterval *minuend,
  2962. OCIInterval *subtrahend, OCIInterval *result );
  2963. NAME - OCIIntervalSubtract - subtracts two intervals
  2964. PARAMETERS
  2965. hndl (IN) - Session/Env handle.
  2966. err (IN/OUT) - error handle. If there is an error, it is
  2967. recorded in 'err' and this function returns OCI_ERROR.
  2968. The error recorded in 'err' can be retrieved by calling
  2969. OCIErrorGet().
  2970. minuend (IN) - interval to be subtracted from
  2971. subtrahend (IN) - interval subtracted from minuend
  2972. result (OUT) - resulting interval (minuend - subtrahend)
  2973. DESCRIPTION
  2974. Subtracts two intervals and stores the result in an interval
  2975. RETURNS
  2976. OCI_SUCCESS on success
  2977. OCI_INVALID_HANDLE if 'err' is NULL.
  2978. OCI_ERROR if:
  2979. the two input intervals are not mutually comparable.
  2980. the resulting leading field would go below SB4MINVAL
  2981. the resulting leading field would go above SB4MAXVAL
  2982. ---------------------- OCIIntervalMultiply ---------------------------------
  2983. sword OCIIntervalMultiply(dvoid *hndl, OCIError *err, CONST OCIInterval *inter,
  2984. OCINumber *nfactor, OCIInterval *result );
  2985. DESCRIPTION
  2986. Multiplies an interval by an Oracle Number to produce an interval
  2987. PARAMETERS
  2988. hndl (IN) - Session/Env handle.
  2989. err (IN/OUT) - error handle. If there is an error, it is
  2990. recorded in 'err' and this function returns OCI_ERROR.
  2991. The error recorded in 'err' can be retrieved by calling
  2992. OCIErrorGet().
  2993. inter (IN) - Interval to be multiplied
  2994. nfactor (IN) - Oracle Number to be multiplied
  2995. result (OUT) - resulting interval (ifactor * nfactor)
  2996. RETURNS
  2997. OCI_SUCCESS on success
  2998. OCI_INVALID_HANDLE if 'err' is NULL.
  2999. OCI_ERROR if:
  3000. the resulting year would go above SB4MAXVAL
  3001. the resulting year would go below SB4MINVAL
  3002. ---------------------- OCIIntervalSetDaySecond --------------------
  3003. DESCRIPTION
  3004. Sets day second interval
  3005. PARAMETERS
  3006. hndl (IN) - Session/Env handle.
  3007. err (IN/OUT) - error handle. If there is an error, it is
  3008. recorded in 'err' and this function returns OCI_ERROR.
  3009. The error recorded in 'err' can be retrieved by calling
  3010. OCIErrorGet().
  3011. day (IN) - number of days
  3012. hour (IN) - number of hours
  3013. min (IN) - number of mins
  3014. sec (IN) - number of secs
  3015. fsec (IN) - number of fractional seconds
  3016. result (OUT) - resulting interval
  3017. RETURNS
  3018. OCI_SUCCESS on success
  3019. OCI_INVALID_HANDLE if 'err' is NULL.
  3020. ---------------------- OCIIntervalSetYearMonth --------------------
  3021. DESCRIPTION
  3022. Sets year month interval
  3023. PARAMETERS
  3024. hndl (IN) - Session/Env handle.
  3025. err (IN/OUT) - error handle. If there is an error, it is
  3026. recorded in 'err' and this function returns OCI_ERROR.
  3027. The error recorded in 'err' can be retrieved by calling
  3028. OCIErrorGet().
  3029. year (IN) - year value
  3030. month (IN) - month value
  3031. result (OUT) - resulting interval
  3032. RETURNS
  3033. OCI_SUCCESS on success
  3034. OCI_INVALID_HANDLE if 'err' is NULL.
  3035. ----------------------- OCIIntervalToNumber ---------------------------------
  3036. sword OCIIntervalToNumber(dvoid *hndl, OCIError *err, CONST OCIInterval *inter,
  3037. OCINumber *number);
  3038. DESCRIPTION
  3039. Converts an interval to an Oracle Number
  3040. PARAMETERS
  3041. hndl (IN) - Session/Env handle.
  3042. err (IN/OUT) - error handle. If there is an error, it is
  3043. recorded in 'err' and this function returns OCI_ERROR.
  3044. The error recorded in 'err' can be retrieved by calling
  3045. OCIErrorGet().
  3046. (IN) inter - Interval to be converted
  3047. (OUT) number - Oracle number result (in years for YEARMONTH interval
  3048. and in days for DAYSECOND)
  3049. RETURNS
  3050. OCI_INVALID_HANDLE if 'err' is NULL.
  3051. OCI_SUCCESS on success
  3052. NOTES
  3053. Fractional portions of the date (for instance, minutes and seconds if
  3054. the unit chosen is hours) will be included in the Oracle number produced.
  3055. Excess precision will be truncated.
  3056. ------------------------------- OCIIntervalToText -------------------------
  3057. sword OCIIntervalToText( dvoid *hndl, OCIError *err, CONST OCIInterval *inter,
  3058. ub1 lfprec, ub1 fsprec, OraText *buffer,
  3059. size_t buflen, size_t *resultlen );
  3060. DESCRIPTION
  3061. Given an interval, produces a string representing the interval.
  3062. PARAMETERS
  3063. hndl (IN) - Session/Env handle.
  3064. err (IN/OUT) - error handle. If there is an error, it is
  3065. recorded in 'err' and this function returns OCI_ERROR.
  3066. The error recorded in 'err' can be retrieved by calling
  3067. OCIErrorGet().
  3068. (IN) inter - Interval to be converted
  3069. (IN) lfprec - Leading field precision. Number of digits used to
  3070. represent the leading field.
  3071. (IN) fsprec - Fractional second precision of the interval. Number of
  3072. digits used to represent the fractional seconds.
  3073. (OUT) buffer - buffer to hold result
  3074. (IN) buflen - length of above buffer
  3075. (OUT) resultlen - length of result placed into buffer
  3076. RETURNS
  3077. OCI_SUCCESS on success
  3078. OCI_INVALID_HANDLE if 'err' is NULL.
  3079. OCI_ERROR
  3080. if the buffer is not large enough to hold the result
  3081. NOTES
  3082. The interval literal will be output as `year' or `[year-]month' for
  3083. YEAR-MONTH intervals and as `seconds' or `minutes[:seconds]' or
  3084. `hours[:minutes[:seconds]]' or `days[ hours[:minutes[:seconds]]]' for
  3085. DAY-TIME intervals (where optional fields are surrounded by brackets).
  3086. ---------------------- OCIIntervalFromTZ --------------------
  3087. sword OCIIntervalFromTZ(dvoid *hndl, OCIError *err, CONST oratext *inpstring,
  3088. size_t str_len, OCIInterval *result);
  3089. DESCRIPTION
  3090. Retuns an OCI_DTYPE_INTERVAL_DS OCIInterval with the region id (if
  3091. the region is specified in the input string) set and the current
  3092. absolute offset or an absolut offset with the region id set to 0.
  3093. PARAMETERS
  3094. hndl (IN) - Session/Env handle.
  3095. err (IN/OUT) - error handle. If there is an error, it is
  3096. recorded in 'err' and this function returns OCI_ERROR.
  3097. The error recorded in 'err' can be retrieved by calling
  3098. OCIErrorGet().
  3099. inpstring (IN) - pointer to the input string
  3100. str_len (IN) - inpstring length
  3101. result - Output Interval
  3102. RETURNS
  3103. OCI_SUCCESS on success
  3104. OCI_INVALID_HANDLE if 'err' is NULL.
  3105. OCI_ERROR on error
  3106. Bad interval type
  3107. Timezone errors
  3108. NOTES
  3109. The input string must be of the form [+/-]TZH:TZM or 'TZR [TZD]'
  3110. ----------------------- OCIKerbAttrSet ---------------------
  3111. sword OCIKerbAttrSet(OCISession *trgthndlp, ub4 auth_mode,
  3112. ub1 *ftgt_ticket, ub4 ftgt_ticket_len,
  3113. ub1 *ftgt_sesskey, ub4 ftgt_sesskey_len,
  3114. ub2 ftgt_keytype, ub4 ftgt_ticket_flags,
  3115. sb4 ftgt_auth_time, sb4 ftgt_start_time,
  3116. sb4 ftgt_end_time, sb4 ftgt_renew_time,
  3117. text *ftgt_principal, ub4 ftgt_principal_len,
  3118. text *ftgt_realm, ub4 ftgt_realm_len,
  3119. OCIError *errhp);
  3120. DESCRIPTION
  3121. This call sets the attributes required for Kerberos authentication
  3122. on the user handle.
  3123. PARAMETERS
  3124. trgthndlp (IN) - The pointer to a user handle.
  3125. auth_mode (IN) - Indicates what type of Kerberos credentials should
  3126. be set. Options are:
  3127. OCI_KERBCRED_PROXY
  3128. - Set Kerberos credentials for use with
  3129. proxy authentication.
  3130. OCI_KERBCRED_CLIENT_IDENTIFIER
  3131. - Set Kerberos credentials for use
  3132. with secure client identifier.
  3133. ftgt_ticket (IN) - Forwardable Ticket Granting Ticket (FTGT).
  3134. ftgt_ticket_len (IN) - Length of FTGT.
  3135. ftgt_sesskey(IN) - Session Key associated with FTGT.
  3136. ftgt_sesskey_len (IN) - Length of session key.
  3137. ftgt_keytype (IN) - Type of encryption key used to encrypt FTGT.
  3138. ftgt_ticket_flags (IN) - Flags associated with encryption of FTGT.
  3139. ftgt_auth_time (IN) - Authentication time compatible with that in FTGT.
  3140. ftgt_start_time (IN) - Start time compatible with that indicated in FTGT.
  3141. ftgt_end_time (IN) - End time compatible with that indicated in FTGT.
  3142. ftgt_renew_time (IN) - Renew time compatible with that indicated in FTGT.
  3143. ftgt_principal (IN) - Client principal name from FTGT.
  3144. ftgt_principal_len (IN) - Length of client principal name.
  3145. ftgt_realm (IN) - Client realm name from FTGT.
  3146. ftgt_realm_len (IN) - Client realm name length.
  3147. errhp (IN/OUT) - error handle. If there is an error, it is
  3148. recorded in 'err' and this function returns OCI_ERROR.
  3149. The error recorded in 'err' can be retrieved by calling
  3150. OCIErrorGet().
  3151. RETURNS
  3152. OCI_SUCCESS on success
  3153. OCI_ERROR on error
  3154. NOTES
  3155. OCILdaToSvcCtx()
  3156. Name
  3157. OCI toggle version 7 Lda_Def to SerVice context handle
  3158. Purpose
  3159. Converts a V7 Lda_Def to a V8 service context handle.
  3160. Syntax
  3161. sword OCILdaToSvcCtx ( OCISvcCtx **svchpp,
  3162. OCIError *errhp,
  3163. Lda_Def *ldap );
  3164. Comments
  3165. Converts a V7 Lda_Def to a V8 service context handle. The action of this call
  3166. can be reversed by passing the resulting service context handle to the
  3167. OCISvcCtxToLda() function.
  3168. Parameters
  3169. svchpp (IN/OUT) - the service context handle.
  3170. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  3171. diagnostic information in the event of an error.
  3172. ldap (IN/OUT) - the V7 logon data area returned by OCISvcCtxToLda() from
  3173. this service context.
  3174. Related Functions
  3175. OCISvcCtxToLda()
  3176. OCILobAppend()
  3177. Name
  3178. OCI Lob APpend
  3179. Purpose
  3180. Appends a LOB value at the end of another LOB.
  3181. Syntax
  3182. sword OCILobAppend ( OCISvcCtx *svchp,
  3183. OCIError *errhp,
  3184. OCILobLocator *dst_locp,
  3185. OCILobLocator *src_locp );
  3186. Comments
  3187. Appends a LOB value at the end of LOB. The data is
  3188. copied from the source to the destination at the end of the destination. The
  3189. source and the destination must already exist. The destination LOB is
  3190. extended to accommodate the newly written data.
  3191. It is an error to extend the destination LOB beyond the maximum length
  3192. allowed or to try to copy from a NULL LOB.
  3193. Parameters
  3194. svchp (IN) - the service context handle.
  3195. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  3196. diagnostic information in the event of an error.
  3197. dst_locp (IN/OUT) - a locator uniquely referencing the destination LOB.
  3198. src_locp (IN/OUT) - a locator uniquely referencing the source LOB.
  3199. Related Functions
  3200. OCILobTrim()
  3201. OCIErrorGet()
  3202. OCILobWrite()
  3203. OCILobCopy()
  3204. OCILobAssign()
  3205. Name
  3206. OCI Lob ASsiGn
  3207. Purpose
  3208. Assigns one LOB/FILE locator to another.
  3209. Syntax
  3210. sword OCILobAssign ( OCIEnv *envhp,
  3211. OCIError *errhp,
  3212. CONST OCILobLocator *src_locp,
  3213. OCILobLocator **dst_locpp );
  3214. Comments
  3215. Assign source locator to destination locator. After the assignment, both
  3216. locators refer to the same LOB data. For internal LOBs, the source locator's
  3217. LOB data gets copied to the destination locator's LOB data only when the
  3218. destination locator gets stored in the table. Therefore, issuing a flush of
  3219. the object containing the destination locator will copy the LOB data. For
  3220. FILEs only the locator that refers to the OS file is copied to the table. The
  3221. OS file is not copied.
  3222. Note: The only difference between this and OCILobLocatorAssign is that this
  3223. takes an environment handle whereas OCILobLocatorAssign takes an OCI service
  3224. handle
  3225. Parameters
  3226. envhp (IN/OUT) - OCI environment handle initialized in object mode.
  3227. errhp (IN/OUT) - The OCI error handle. If there is an error, it is recorded
  3228. in errhp and this function returns OCI_ERROR. Diagnostic information can be
  3229. obtained by calling OCIErrorGet().
  3230. src_locp (IN) - LOB locator to copy from.
  3231. dst_locpp (IN/OUT) - LOB locator to copy to. The caller must allocate space
  3232. for the OCILobLocator by calling OCIDescriptorAlloc().
  3233. See also
  3234. OCIErrorGet()
  3235. OCILobIsEqual()
  3236. OCILobLocatorIsInit()
  3237. OCILobLocatorAssign()
  3238. OCILobCharSetForm()
  3239. Name
  3240. OCI Lob Get Character Set Form
  3241. Purpose
  3242. Gets the LOB locator's character set fpr,, if any.
  3243. Syntax
  3244. sword OCILobCharSetForm ( OCIEnv *envhp,
  3245. OCIError *errhp,
  3246. CONST OCILobLocator *locp,
  3247. ub1 *csfrm );
  3248. Comments
  3249. Returns the character set form of the input LOB locator in the csfrm output
  3250. parameter.
  3251. Parameters
  3252. envhp (IN/OUT) - OCI environment handle initialized in object mode.
  3253. errhp (IN/OUT) - error handle. The OCI error handle. If there is an error, it
  3254. is recorded in err and this function returns OCI_ERROR. Diagnostic
  3255. information can be obtained by calling OCIErrorGet().
  3256. locp (IN) - LOB locator for which to get the character set form.
  3257. csfrm(OUT) - character set form of the input LOB locator. If the input
  3258. locator is for a BLOB or a BFILE, csfrm is set to 0 since there is no concept
  3259. of a character set for binary LOBs/FILEs. The caller must allocate space for
  3260. the csfrm (ub1) and not write into the space.
  3261. See also
  3262. OCIErrorGet(), OCILobCharSetId(), OCILobLocatorIsInit
  3263. OCILobCharSetId()
  3264. Name
  3265. OCI Lob get Character Set IDentifier
  3266. Purpose
  3267. Gets the LOB locator's character set ID, if any.
  3268. Syntax
  3269. sword OCILobCharSetId ( OCIEnv *envhp,
  3270. OCIError *errhp,
  3271. CONST OCILobLocator *locp,
  3272. ub2 *csid );
  3273. Comments
  3274. Returns the character set ID of the input LOB locator in the cid output
  3275. parameter.
  3276. Parameters
  3277. envhp (IN/OUT) - OCI environment handle initialized in object mode.
  3278. errhp (IN/OUT) - error handle. The OCI error handle. If there is an error, it
  3279. is recorded in err and this function returns OCI_ERROR. Diagnostic
  3280. information can be obtained by calling OCIErrorGet().
  3281. locp (IN) - LOB locator for which to get the character set ID.
  3282. csid (OUT) - character set ID of the input LOB locator. If the input locator
  3283. is for a BLOB or a BFILE, csid is set to 0 since there is no concept of a
  3284. character set for binary LOBs/FILEs. The caller must allocate space for the
  3285. character set id of type ub2 and not write into the space.
  3286. See also
  3287. OCIErrorGet(), OCILobCharSetForm(), OCILobLocatorIsInit()
  3288. OCILobCopy()
  3289. Name
  3290. OCI Lob Copy
  3291. Purpose
  3292. Copies a portion of a LOB value into another LOB value.
  3293. Syntax
  3294. sword OCILobCopy ( OCISvcCtx *svchp,
  3295. OCIError *errhp,
  3296. OCILobLocator *dst_locp,
  3297. OCILobLocator *src_locp,
  3298. ub4 amount,
  3299. ub4 dst_offset,
  3300. ub4 src_offset );
  3301. Comments
  3302. Copies a portion of a LOB value into another LOB as specified. The data
  3303. is copied from the source to the destination. The source (src_locp) and the
  3304. destination (dlopb) LOBs must already exist.
  3305. If the data already exists at the destination's start position, it is
  3306. overwritten with the source data. If the destination's start position is
  3307. beyond the end of the current data, a hole is created from the end of the data
  3308. to the beginning of the newly written data from the source. The destination
  3309. LOB is extended to accommodate the newly written data if it extends
  3310. beyond the current length of the destination LOB.
  3311. It is an error to extend the destination LOB beyond the maximum length
  3312. allowed or to try to copy from a NULL LOB.
  3313. Parameters
  3314. svchp (IN) - the service context handle.
  3315. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  3316. diagnostic information in the event of an error.
  3317. dst_locp (IN/OUT) - a locator uniquely referencing the destination LOB.
  3318. src_locp (IN/OUT) - a locator uniquely referencing the source LOB.
  3319. amount (IN) - the number of character or bytes, as appropriate, to be copied.
  3320. dst_offset (IN) - this is the absolute offset for the destination LOB.
  3321. For character LOBs it is the number of characters from the beginning of the
  3322. LOB at which to begin writing. For binary LOBs it is the number of bytes from
  3323. the beginning of the lob from which to begin reading. The offset starts at 1.
  3324. src_offset (IN) - this is the absolute offset for the source LOB.
  3325. For character LOBs it is the number of characters from the beginning of the
  3326. LOB, for binary LOBs it is the number of bytes. Starts at 1.
  3327. See Also
  3328. OCIErrorGet(), OCILobAppend(), OCILobWrite(), OCILobTrim()
  3329. OCILobCreateTemporary()
  3330. Name
  3331. OCI Lob Create Temporary
  3332. Purpose
  3333. Create a Temporary Lob
  3334. Syntax
  3335. sword OCILobCreateTemporary(OCISvcCtx *svchp,
  3336. OCIError *errhp,
  3337. OCILobLocator *locp,
  3338. ub2 csid,
  3339. ub1 csfrm,
  3340. ub1 lobtype,
  3341. boolean cache,
  3342. OCIDuration duration);
  3343. Comments
  3344. svchp (IN) - the service context handle.
  3345. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  3346. diagnostic information in the event of an error.
  3347. locp (IN/OUT) - a locator which points to the temporary Lob
  3348. csid (IN) - the character set id
  3349. csfrm(IN) - the character set form
  3350. lobtype (IN) - the lob type - one of the three constants OCI_TEMP_BLOB,
  3351. OCI_TEMP_CLOB and OCI_TEMP_NCLOB
  3352. cache(IN)- TRUE if the temporary LOB goes through the cache; FALSE, if not.
  3353. duration(IN)- duration of the temporary LOB; Can be a valid duration id or one
  3354. of the values: OCI_DURATION_SESSION, OCI_DURATION_CALL
  3355. Note: OCI_DURATION_TRANSACTION is NOT supported in 8.1
  3356. Related functions
  3357. OCILobFreeTemporary()
  3358. OCILobIsTemporary()
  3359. OCILobDisableBuffering()
  3360. Name
  3361. OCI Lob Disable Buffering
  3362. Purpose
  3363. Disable lob buffering for the input locator.
  3364. Syntax
  3365. sword OCILobDisableBuffering ( OCISvcCtx *svchp,
  3366. OCIError *errhp,
  3367. OCILobLocator *locp);
  3368. Comments
  3369. Disable lob buffering for the input locator. The next time data is
  3370. read/written from/to the lob through the input locator, the lob
  3371. buffering subsystem is *not* used. Note that this call does *not*
  3372. implicitly flush the changes made in the buffering subsystem. The
  3373. user must explicitly call OCILobFlushBuffer() to do this.
  3374. Parameters
  3375. svchp (IN) - the service context handle.
  3376. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  3377. diagnostic information in the event of an error.
  3378. locp (IN/OUT) - a locator uniquely referencing the LOB.
  3379. Related Functions
  3380. OCILobEnableBuffering()
  3381. OCIErrorGet()
  3382. OCILobFlushBuffer()
  3383. OCILobEnableBuffering()
  3384. Name
  3385. OCI Lob Enable Buffering
  3386. Purpose
  3387. Enable lob buffering for the input locator.
  3388. Syntax
  3389. sword OCILobEnableBuffering ( OCISvcCtx *svchp,
  3390. OCIError *errhp,
  3391. OCILobLocator *locp);
  3392. Comments
  3393. Enable lob buffering for the input locator. The next time data is
  3394. read/written from/to the lob through the input locator, the lob
  3395. buffering subsystem is used.
  3396. Once lob buffering is enabled for a locator, if that locator is passed to
  3397. one of the following routines, an error is returned:
  3398. OCILobCopy, OCILobAppend, OCILobErase, OCILobGetLength, OCILobTrim
  3399. Parameters
  3400. svchp (IN) - the service context handle.
  3401. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  3402. diagnostic information in the event of an error.
  3403. locp (IN/OUT) - a locator uniquely referencing the LOB.
  3404. Related Functions
  3405. OCILobDisableBuffering()
  3406. OCIErrorGet()
  3407. OCILobWrite()
  3408. OCILobRead()
  3409. OCILobFlushBuffer()
  3410. OCILobErase()
  3411. Name
  3412. OCI Lob ERase
  3413. Purpose
  3414. Erases a specified portion of the LOB data starting at a specified offset.
  3415. Syntax
  3416. sword OCILobErase ( OCISvcCtx *svchp,
  3417. OCIError *errhp,
  3418. OCILobLocator *locp,
  3419. ub4 *amount,
  3420. ub4 offset );
  3421. Comments
  3422. Erases a specified portion of the LOB data starting at a specified offset.
  3423. The actual number of characters/bytes erased is returned. The actual number
  3424. of characters/bytes and the requested number of characters/bytes will differ
  3425. if the end of the LOB data is reached before erasing the requested number of
  3426. characters/bytes.
  3427. If a section of data from the middle of the LOB data is erased, a hole is
  3428. created. When data from that hole is read, 0's are returned. If the LOB is
  3429. NULL, this routine will indicate that 0 characters/bytes were erased.
  3430. Parameters
  3431. svchp (IN) - the service context handle.
  3432. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  3433. diagnostic information in the event of an error.
  3434. locp (IN/OUT) - the LOB for which to erase a section of data.
  3435. amount (IN/OUT) - On IN, the number of characters/bytes to erase. On OUT,
  3436. the actual number of characters/bytes erased.
  3437. offset (IN) - absolute offset from the beginning of the LOB data from which
  3438. to start erasing data. Starts at 1.
  3439. See Also
  3440. OCIErrorGet(), OCILobRead(), OCILobWrite()
  3441. OCILobOpen()
  3442. Name
  3443. OCI Lob Open
  3444. Purpose
  3445. Opens an internal or external Lob.
  3446. Syntax
  3447. sword OCILobOpen( OCISvcCtx *svchp,
  3448. OCIError *errhp,
  3449. OCILobLocator *locp,
  3450. ub1 mode );
  3451. Comments
  3452. It is an error if the same lob is opened more than once in
  3453. the same transaction. Lobs are opened implicitly if they are
  3454. not opened before using them. A LOB has to be closed before
  3455. the transaction commits else the transaction is rolled back.
  3456. Open locators are closed if the transaction aborts. Multiple
  3457. users can open the same lob on different locators.
  3458. Parameters
  3459. svchp (IN) - the service context handle.
  3460. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  3461. diagnostic information in the event of an error.
  3462. locp (IN/OUT) - locator points to the LOB to be opened
  3463. mode (IN) - mode in which to open the lob. The valid modes are
  3464. read-only - OCI_FILE_READONLY, read-write - OCI_FILE_READWRITE
  3465. OCILobClose()
  3466. Name
  3467. OCI Lob Close
  3468. Purpose
  3469. Closes an open internal or external Lob.
  3470. Syntax
  3471. sword OCILobClose( OCISvcCtx *svchp,
  3472. OCIError *errhp,
  3473. OCILobLocator *locp );
  3474. Comments
  3475. It is an error if the lob is not open at this time. All LOBs
  3476. that have been opened in a transaction have to be closed
  3477. before the transaction commits, else the transaction gets
  3478. rolled back.
  3479. Parameters
  3480. svchp (IN) - the service context handle.
  3481. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  3482. diagnostic information in the event of an error.
  3483. locp (IN) - A locator that was opened using OCILobOpen()
  3484. OCILobFileClose()
  3485. Name
  3486. OCI Lob File CLoSe
  3487. Purpose
  3488. Closes a previously opened FILE.
  3489. Syntax
  3490. sword OCILobFileClose ( OCISvcCtx *svchp,
  3491. OCIError *errhp,
  3492. OCILobLocator *filep );
  3493. Comments
  3494. Closes a previously opened FILE. It is an error if this function is called for
  3495. an internal LOB. No error is returned if the FILE exists but is not opened.
  3496. Parameters
  3497. svchp (IN) - the service context handle.
  3498. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  3499. diagnostic information in the event of an error.
  3500. filep (IN/OUT) - a pointer to a FILE locator to be closed.
  3501. See Also
  3502. OCIErrorGet(), OCILobFileOpen(), OCILobFileCloseAll(), OCILobFileIsOpen(),
  3503. OCILobFileExists(), CREATE DIRECTORY DDL
  3504. OCILobFileCloseAll()
  3505. Name
  3506. OCI LOB FILE Close All
  3507. Purpose
  3508. Closes all open FILEs on a given service context.
  3509. Syntax
  3510. sword OCILobFileCLoseAll ( OCISvcCtx *svchp,
  3511. OCIError *errhp );
  3512. Comments
  3513. Closes all open FILEs on a given service context.
  3514. Parameters
  3515. svchp (IN) - the service context handle.
  3516. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  3517. diagnostic information in the event of an error.
  3518. See also
  3519. OCILobFileClose(),
  3520. OCIErrorGet(), OCILobFileOpen(), OCILobFileIsOpen(),
  3521. OCILobFileExists(), CREATE DIRECTORY DDL
  3522. OCILobFileExists()
  3523. Name
  3524. OCI LOB FILE exists
  3525. Purpose
  3526. Tests to see if the FILE exists on the server
  3527. Syntax
  3528. sword OCILobFileExists ( OCISvcCtx *svchp,
  3529. OCIError *errhp,
  3530. OCILobLocator *filep,
  3531. boolean *flag );
  3532. Comments
  3533. Checks to see if a FILE exists for on the server.
  3534. Parameters
  3535. svchp (IN) - the OCI service context handle.
  3536. errhp (IN/OUT) - error handle. The OCI error handle. If there is an error,
  3537. it is recorded in err and this function returns OCI_ERROR. Diagnostic
  3538. information can be obtained by calling OCIErrorGet().
  3539. filep (IN) - pointer to the FILE locator that refers to the file.
  3540. flag (OUT) - returns TRUE if the FILE exists; FALSE if it does not.
  3541. See also
  3542. OCIErrorGet, CREATE DIRECTORY (DDL)
  3543. OCILobFileGetName()
  3544. Name
  3545. OCI LOB FILE Get file Name
  3546. Purpose
  3547. Gets the FILE locator's directory alias and file name.
  3548. Syntax
  3549. sword OCILobFileGetName ( OCIEnv *envhp,
  3550. OCIError *errhp,
  3551. CONST OCILobLocator *filep,
  3552. OraText *dir_alias,
  3553. ub2 *d_length,
  3554. OraText *filename,
  3555. ub2 *f_length );
  3556. Comments
  3557. Returns the directory alias and file name associated with this file locator.
  3558. Parameters
  3559. envhp (IN/OUT) - OCI environment handle initialized in object mode.
  3560. errhp (IN/OUT) -The OCI error handle. If there is an error, it is recorded in
  3561. errhp and this function returns OCI_ERROR. Diagnostic information can be
  3562. obtained by calling OCIErrorGet().
  3563. filep (IN) - FILE locator for which to get the directory alias and file name.
  3564. dir_alias (OUT) - buffer into which the directory alias name is placed. The
  3565. caller must allocate enough space for the directory alias name and must not
  3566. write into the space.
  3567. d_length (IN/OUT)
  3568. - IN: length of the input dir_alias string;
  3569. - OUT: length of the returned dir_alias string.
  3570. filename (OUT) - buffer into which the file name is placed. The caller must
  3571. allocate enough space for the file name and must not write into the space.
  3572. f_length (IN/OUT)
  3573. - IN: length of the input filename string;
  3574. - OUT: lenght of the returned filename string.
  3575. See also
  3576. OCILobFileSetName(), OCIErrorGet()
  3577. OCILobFileIsOpen()
  3578. Name
  3579. OCI LOB FILE Is Open?
  3580. Purpose
  3581. Tests to see if the FILE is open
  3582. Syntax
  3583. sword OCILobFileIsOpen ( OCISvcCtx *svchp,
  3584. OCIError *errhp,
  3585. OCILobLocator *filep,
  3586. boolean *flag );
  3587. Comments
  3588. Checks to see if the FILE on the server is open for a given LobLocator.
  3589. Parameters
  3590. svchp (IN) - the OCI service context handle.
  3591. errhp (IN/OUT) - error handle. The OCI error handle. If there is an error, it
  3592. is recorded in err and this function returns OCI_ERROR. Diagnostic
  3593. information can be obtained by calling OCIErrorGet().
  3594. filep (IN) - pointer to the FILE locator being examined. If the input file
  3595. locator was never passed to OCILobFileOpen(), the file is considered not to
  3596. be opened by this locator. However, a different locator may have opened the
  3597. file. More than one file opens can be performed on the same file using
  3598. different locators.
  3599. flag (OUT) - returns TRUE if the FILE is opened using this locator; FALSE if
  3600. it is not.
  3601. See also
  3602. OCIErrorGet, OCILobFileOpen, OCILobFileClose, OCILobFileCloseAll, CREATE
  3603. DIRECTORY SQL command
  3604. OCILobFileOpen()
  3605. Name
  3606. OCI LOB FILE open
  3607. Purpose
  3608. Opens a FILE for read-only access
  3609. Syntax
  3610. sword OCILobFileOpen ( OCISvcCtx *svchp,
  3611. OCIError *errhp,
  3612. OCILobLocator *filep,
  3613. ub1 mode );
  3614. Comments
  3615. Opens a FILE. The FILE can be opened for read-only access only. FILEs may not
  3616. be written to throough ORACLE.
  3617. Parameters
  3618. svchp (IN) - the service context handle.
  3619. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  3620. diagnostic information in the event of an error.
  3621. filep (IN/OUT) - the FILE to open. Error if the locator does not refer to a
  3622. FILE.
  3623. mode (IN) - mode in which to open the file. The only valid mode is
  3624. read-only - OCI_FILE_READONLY.
  3625. See Also
  3626. OCILobFileClose, OCIErrorGet, OCILobFileCloseAll, OCILobFileIsOpen,
  3627. OCILobFileSetName, CREATE DIRECTORY
  3628. OCILobFileSetName()
  3629. Name
  3630. OCI Lob File Set NaMe
  3631. Purpose
  3632. Sets directory alias and file name in the FILE locator.
  3633. Syntax
  3634. sword OCILobFileSetName ( OCIEnv *envhp,
  3635. OCIError *errhp,
  3636. OCILobLocator **filepp,
  3637. OraText *dir_alias,
  3638. ub2 d_length,
  3639. OraText *filename,
  3640. ub2 f_length );
  3641. Comments
  3642. Sets the directory alias and file name in the LOB file locator.
  3643. Parameters
  3644. envhp (IN/OUT) - OCI environment handle initialized in object mode.
  3645. errhp (IN/OUT) - The OCI error handle. If there is an error, it is recorded
  3646. in errhp and this function returns OCI_ERROR. Diagnostic information can be
  3647. obtained by calling OCIErrorGet().
  3648. filepp (IN/OUT) - FILE locator for which to set the directory alias name.
  3649. The caller must have already allocated space for the locator by calling
  3650. OCIDescriptorAlloc().
  3651. dir_alias (IN) - buffer that contains the directory alias name to set in the
  3652. locator.
  3653. d_length (IN) - length of the input dir_alias parameter.
  3654. filename (IN) - buffer that contains the file name is placed.
  3655. f_length (IN) - length of the input filename parameter.
  3656. See also
  3657. OCILobFileGetName, OCIErrorGet, CREATE DIRECTORY
  3658. OCILobFlushBuffer()
  3659. Name
  3660. OCI Lob Flush all Buffers for this lob.
  3661. Purpose
  3662. Flush/write all buffers for this lob to the server.
  3663. Syntax
  3664. sword OCILobFlushBuffer ( OCISvcCtx *svchp,
  3665. OCIError *errhp,
  3666. OCILobLocator *locp,
  3667. ub4 flag);
  3668. Comments
  3669. Flushes to the server, changes made to the buffering subsystem that
  3670. are associated with the lob referenced by the input locator. This
  3671. routine will actually write the data in the buffer to the lob in
  3672. the database. Lob buffering must have already been enabled for the
  3673. input lob locator.
  3674. This routine, by default, does not free the buffer resources for
  3675. reallocation to another buffered LOB operation. However, if you
  3676. want to free the buffer explicitly, you can set the flag parameter
  3677. to OCI_LOB_BUFFER_FREE.
  3678. Parameters
  3679. svchp (IN/OUT) - the service context handle.
  3680. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  3681. diagnostic information in the event of an error.
  3682. locp (IN/OUT) - a locator uniquely referencing the LOB.
  3683. flag (IN) - to indicate if the buffer resources need to be freed
  3684. after a flush. Default value is OCI_LOB_BUFFER_NOFREE.
  3685. Set it to OCI_LOB_BUFFER_FREE if you want the buffer
  3686. resources to be freed.
  3687. Related Functions
  3688. OCILobEnableBuffering()
  3689. OCILobDisableBuffering()
  3690. OCIErrorGet()
  3691. OCILobWrite()
  3692. OCILobRead()
  3693. OCILobFreeTemporary()
  3694. Name
  3695. OCI Lob Free Temporary
  3696. Purpose
  3697. Free a temporary LOB
  3698. Syntax
  3699. sword OCILobFreeTemporary(OCISvcCtx *svchp,
  3700. OCIError *errhp,
  3701. OCILobLocator *locp);
  3702. Comments
  3703. Frees the contents of the temporary Lob this locator is pointing to. Note
  3704. that the locator itself is not freed until a OCIDescriptorFree is done.
  3705. Parameters
  3706. svchp (IN/OUT) - the service context handle.
  3707. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  3708. diagnostic information in the event of an error.
  3709. locp (IN/OUT) - a locator uniquely referencing the LOB
  3710. Related functions
  3711. OCILobCreateTemporary()
  3712. OCILobIsTemporary()
  3713. Name
  3714. OCI Lob/File Get Chunk Size
  3715. Purpose
  3716. When creating the table, the user can specify the chunking factor, which can
  3717. be a multiple of Oracle blocks. This corresponds to the chunk size used by the
  3718. LOB data layer when accessing/modifying the LOB value. Part of the chunk is
  3719. used to store system-related information and the rest stores the LOB value.
  3720. This function returns the amount of space used in the LOB chunk to store
  3721. the LOB value.
  3722. Syntax
  3723. sword OCILobGetChunkSize ( OCISvcCtx *svchp,
  3724. OCIError *errhp,
  3725. OCILobLocator *locp,
  3726. ub4 *chunksizep );
  3727. Comments
  3728. Performance will be improved if the user issues read/write
  3729. requests using a multiple of this chunk size. For writes, there is an added
  3730. benefit since LOB chunks are versioned and, if all writes are done on chunk
  3731. basis, no extra/excess versioning is done nor duplicated. Users could batch
  3732. up the write until they have enough for a chunk instead of issuing several
  3733. write calls for the same chunk.
  3734. Parameters
  3735. svchp (IN) - the service context handle.
  3736. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  3737. diagnostic information in the event of an error.
  3738. locp (IN/OUT) - a LOB locator that uniquely references the LOB. For internal
  3739. LOBs, this locator must be a locator that was obtained from the server
  3740. specified by svchp. For FILEs, this locator can be initialized by a Select or
  3741. OCILobFileSetName.
  3742. chunksizep (OUT) - On output, it is the length of the LOB if not NULL - for
  3743. character LOBs it is the number of characters, for binary LOBs it is the
  3744. number of bytes in the LOB.
  3745. Related Functions
  3746. OCILobGetLength()
  3747. Name
  3748. OCI Lob/File Length
  3749. Purpose
  3750. Gets the length of a LOB/FILE.
  3751. Syntax
  3752. sword OCILobGetLength ( OCISvcCtx *svchp,
  3753. OCIError *errhp,
  3754. OCILobLocator *locp,
  3755. ub4 *lenp );
  3756. Comments
  3757. Gets the length of a LOB/FILE. If the LOB/FILE is NULL, the length is
  3758. undefined.
  3759. Parameters
  3760. svchp (IN) - the service context handle.
  3761. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  3762. diagnostic information in the event of an error.
  3763. locp (IN/OUT) - a LOB locator that uniquely references the LOB. For internal
  3764. LOBs, this locator must be a locator that was obtained from the server
  3765. specified by svchp. For FILEs, this locator can be initialized by a Select or
  3766. OCILobFileSetName.
  3767. lenp (OUT) - On output, it is the length of the LOB if not NULL - for
  3768. character LOBs it is the number of characters, for binary LOBs it is the
  3769. number of bytes in the LOB.
  3770. Related Functions
  3771. OCIErrorGet, OCIFileSetName
  3772. OCILobIsEqual()
  3773. Name
  3774. OCI Lob Is Equal
  3775. Purpose
  3776. Compares two LOB locators for equality.
  3777. Syntax
  3778. sword OCILobIsEqual ( OCIEnv *envhp,
  3779. CONST OCILobLocator *x,
  3780. CONST OCILobLocator *y,
  3781. boolean *is_equal );
  3782. Comments
  3783. Compares the given LOB locators for equality. Two LOB locators are equal if
  3784. and only if they both refer to the same LOB data.
  3785. Two NULL locators are considered not equal by this function.
  3786. Parameters
  3787. envhp (IN) - the OCI environment handle.
  3788. x (IN) - LOB locator to compare.
  3789. y (IN) - LOB locator to compare.
  3790. is_equal (OUT) - TRUE, if the LOB locators are equal; FALSE if they are not.
  3791. See also
  3792. OCILobAssign, OCILobLocatorIsInit
  3793. OCILobLocatorAssign,
  3794. OCILobIsOpen()
  3795. Name
  3796. OCI Lob Is Open
  3797. sword OCILobIsOpen(svchp, errhp, locp, flag)
  3798. OCISvcCtx *svchp;
  3799. OCIError *errhp;
  3800. OCILobLocator *locp;
  3801. boolean *flag;
  3802. Comments
  3803. Checks if the LOB locator was opened before. flag is set to TRUE
  3804. if opened; FALSE otherwise
  3805. Parameters
  3806. svchp (IN) - the service context handle.
  3807. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  3808. diagnostic information in the event of an error.
  3809. locp (IN) - the locator to test for temporary LOB
  3810. flag(OUT) - TRUE, if the LOB locator points to is open
  3811. FALSE, if not.
  3812. OCILobIsTemporary()
  3813. Name
  3814. OCI Lob Is Temporary
  3815. Purpose
  3816. Tests if this locator points to a temporary LOB
  3817. Syntax
  3818. sword OCILobIsTemporary(OCIEnv *envhp,
  3819. OCIError *errhp,
  3820. OCILobLocator *locp,
  3821. boolean *is_temporary);
  3822. Comments
  3823. Tests the locator to determine if it points to a temporary LOB.
  3824. If so, is_temporary is set to TRUE. If not, is_temporary is set
  3825. to FALSE.
  3826. Parameters
  3827. envhp (IN) - the environment handle.
  3828. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  3829. diagnostic information in the event of an error.
  3830. locp (IN) - the locator to test for temporary LOB
  3831. is_temporary(OUT) - TRUE, if the LOB locator points to a temporary LOB;
  3832. FALSE, if not.
  3833. See Also
  3834. OCILobCreateTemporary, OCILobFreeTemporary
  3835. OCILobLoadFromFile()
  3836. Name
  3837. OCI Lob Load From File
  3838. Purpose
  3839. Load/copy all or a portion of the file into an internal LOB.
  3840. Syntax
  3841. sword OCILobLoadFromFile ( OCISvcCtx *svchp,
  3842. OCIError *errhp,
  3843. OCILobLocator *dst_locp,
  3844. OCILobLocator *src_filep,
  3845. ub4 amount,
  3846. ub4 dst_offset,
  3847. ub4 src_offset );
  3848. Comments
  3849. Loads/copies a portion or all of a file value into an internal LOB as
  3850. specified. The data is copied from the source file to the destination
  3851. internal LOB (BLOB/CLOB). No character set conversions are performed
  3852. when copying the bfile data to a clob/nclob. The bfile data must already
  3853. be in the same character set as the clob/nclob in the database. No
  3854. error checking is performed to verify this.
  3855. The source (src_filep) and the destination (dst_locp) LOBs must already exist.
  3856. If the data already exists at the destination's start position, it is
  3857. overwritten with the source data. If the destination's start position is
  3858. beyond the end of the current data, a hole is created from the end of the data
  3859. to the beginning of the newly written data from the source. The destination
  3860. LOB is extended to accommodate the newly written data if it extends
  3861. beyond the current length of the destination LOB.
  3862. It is an error to extend the destination LOB beyond the maximum length
  3863. allowed or to try to copy from a NULL LOB.
  3864. Parameters
  3865. svchp (IN) - the service context handle.
  3866. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  3867. diagnostic information in the event of an error.
  3868. dst_locp (IN/OUT) - a locator uniquely referencing the destination internal
  3869. LOB which may be of type blob, clob, or nclob.
  3870. src_filep (IN/OUT) - a locator uniquely referencing the source BFILE.
  3871. amount (IN) - the number of bytes to be copied.
  3872. dst_offset (IN) - this is the absolute offset for the destination LOB.
  3873. For character LOBs it is the number of characters from the beginning of the
  3874. LOB at which to begin writing. For binary LOBs it is the number of bytes from
  3875. the beginning of the lob from which to begin reading. The offset starts at 1.
  3876. src_offset (IN) - this is the absolute offset for the source BFILE. It is
  3877. the number of bytes from the beginning of the LOB. The offset starts at 1.
  3878. See Also
  3879. OCIErrorGet(), OCILobAppend(), OCILobWrite(), OCILobTrim(), OCILobCopy()
  3880. OCILobLocatorAssign()
  3881. Name
  3882. OCI Lob LOCATOR ASsiGn
  3883. Purpose
  3884. Assigns one LOB/FILE locator to another.
  3885. Syntax
  3886. sword OCILobLocatorAssign ( OCISvcCtx *svchp,
  3887. OCIError *errhp,
  3888. CONST OCILobLocator *src_locp,
  3889. OCILobLocator **dst_locpp );
  3890. Comments
  3891. Assign source locator to destination locator. After the assignment, both
  3892. locators refer to the same LOB data. For internal LOBs, the source locator's
  3893. LOB data gets copied to the destination locator's LOB data only when the
  3894. destination locator gets stored in the table. Therefore, issuing a flush of
  3895. the object containing the destination locator will copy the LOB data. For
  3896. FILEs only the locator that refers to the OS file is copied to the table. The
  3897. OS file is not copied.
  3898. Note : the only difference between this and OCILobAssign is that this takes
  3899. a OCI service handle pointer instead of a OCI environment handle pointer
  3900. Parameters
  3901. svchp (IN/OUT) - OCI service handle initialized in object mode.
  3902. errhp (IN/OUT) - The OCI error handle. If there is an error, it is recorded
  3903. in errhp and this function returns OCI_ERROR. Diagnostic information can be
  3904. obtained by calling OCIErrorGet().
  3905. src_locp (IN) - LOB locator to copy from.
  3906. dst_locpp (IN/OUT) - LOB locator to copy to. The caller must allocate space
  3907. for the OCILobLocator by calling OCIDescriptorAlloc().
  3908. See also
  3909. OCIErrorGet()
  3910. OCILobIsEqual()
  3911. OCILobLocatorIsInit()
  3912. OCILobAssign()
  3913. OCILobLocatorIsInit()
  3914. Name
  3915. OCI LOB locator is initialized?
  3916. Purpose
  3917. Tests to see if a given LOB locator is initialized.
  3918. Syntax
  3919. sword OCILobLocatorIsInit ( OCIEnv *envhp,
  3920. OCIError *errhp,
  3921. CONST OCILobLocator *locp,
  3922. boolean *is_initialized );
  3923. Comments
  3924. Tests to see if a given LOB locator is initialized.
  3925. Parameters
  3926. envhp (IN/OUT) - OCI environment handle initialized in object mode.
  3927. errhp (IN/OUT) - error handle. The OCI error handle. If there is an error, it
  3928. is recorded in err and this function returns OCI_ERROR. Diagnostic
  3929. information can be obtained by calling OCIErrorGet().
  3930. locp (IN) - the LOB locator being tested
  3931. is_initialized (OUT) - returns TRUE if the given LOB locator is initialized;
  3932. FALSE if it is not.
  3933. See also
  3934. OCIErrorGet, OCILobIsEqual
  3935. OCILobRead()
  3936. Name
  3937. OCI Lob/File ReaD
  3938. Purpose
  3939. Reads a portion of a LOB/FILE as specified by the call into a buffer.
  3940. Syntax
  3941. sword OCILobRead ( OCISvcCtx *svchp,
  3942. OCIError *errhp,
  3943. OCILobLocator *locp,
  3944. ub4 offset,
  3945. ub4 *amtp,
  3946. dvoid *bufp,
  3947. ub4 bufl,
  3948. dvoid *ctxp,
  3949. OCICallbackLobRead cbfp,
  3950. ub2 csid,
  3951. ub1 csfrm );
  3952. Comments
  3953. Reads a portion of a LOB/FILE as specified by the call into a buffer. Data
  3954. read from a hole is returned as 0s. It is an error to try to read from a NULL
  3955. LOB/FILE. The OS FILE must already exist on the server and must have been
  3956. opened using the input locator. Oracle must hav epermission to read the OS
  3957. file and user must have read permission on the directory object.
  3958. Parameters
  3959. svchp (IN/OUT) - the service context handle.
  3960. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  3961. diagnostic information in the event of an error.
  3962. locp (IN/OUT) - a LOB locator that uniquely references a LOB.
  3963. offset (IN) - On input, it is the absolute offset, for character LOBs in the
  3964. number of characters from the beginning of the LOB, for binary LOBs it is the
  3965. number of bytes. Starts from 1.
  3966. amtp (IN/OUT) - On input, the number of character or bytes to be read. On
  3967. output, the actual number of bytes or characters read.
  3968. If the amount of bytes to be read is larger than the buffer length it is
  3969. assumed that the LOB is being read in a streamed mode. On input if this value
  3970. is 0, then the data shall be read in streamed mode from the LOB until the end
  3971. of LOB. If the data is read in pieces, *amtp always contains the length of
  3972. the last piece read. If a callback function is defined, then this callback
  3973. function will be invoked each time bufl bytes are read off the pipe. Each
  3974. piece will be written into bufp.
  3975. If the callback function is not defined, then OCI_NEED_DATA error code will
  3976. be returned. The application must invoke the LOB read over and over again to
  3977. read more pieces of the LOB until the OCI_NEED_DATA error code is not
  3978. returned. The buffer pointer and the length can be different in each call
  3979. if the pieces are being read into different sizes and location.
  3980. bufp (IN) - the pointer to a buffer into which the piece will be read. The
  3981. length of the allocated memory is assumed to be bufl.
  3982. bufl (IN) - the length of the buffer in octets.
  3983. ctxp (IN) - the context for the call back function. Can be NULL.
  3984. cbfp (IN) - a callback that may be registered to be called for each piece. If
  3985. this is NULL, then OCI_NEED_DATA will be returned for each piece.
  3986. The callback function must return OCI_CONTINUE for the read to continue.
  3987. If any other error code is returned, the LOB read is aborted.
  3988. ctxp (IN) - the context for the call back function. Can be NULL.
  3989. bufp (IN) - a buffer pointer for the piece.
  3990. len (IN) - the length of length of current piece in bufp.
  3991. piece (IN) - which piece - OCI_FIRST_PIECE, OCI_NEXT_PIECE or
  3992. OCI_LAST_PIECE.
  3993. csid - the character set ID of the buffer data
  3994. csfrm - the character set form of the buffer data
  3995. Related Functions
  3996. OCIErrorGet, OCILobWrite, OCILobFileOpen, OCILobFileSetName, CREATE DIRECTORY
  3997. OCILobTrim()
  3998. Name
  3999. OCI Lob Trim
  4000. Purpose
  4001. Trims the lob value to a shorter length
  4002. Syntax
  4003. sword OCILobTrim ( OCISvcCtx *svchp,
  4004. OCIError *errhp,
  4005. OCILobLocator *locp,
  4006. ub4 newlen );
  4007. Comments
  4008. Truncates LOB data to a specified shorter length.
  4009. Parameters
  4010. svchp (IN) - the service context handle.
  4011. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  4012. diagnostic information in the event of an error.
  4013. locp (IN/OUT) - a LOB locator that uniquely references the LOB. This locator
  4014. must be a locator that was obtained from the server specified by svchp.
  4015. newlen (IN) - the new length of the LOB data, which must be less than or equal
  4016. to the current length.
  4017. Related Functions
  4018. OCIErrorGet, OCILobWrite, OCiLobErase, OCILobAppend, OCILobCopy
  4019. OCILobWrite()
  4020. Name
  4021. OCI Lob Write
  4022. Purpose
  4023. Writes a buffer into a LOB
  4024. Syntax
  4025. sword OCILobWrite ( OCISvcCtx *svchp,
  4026. OCIError *errhp,
  4027. OCILobLocator *locp,
  4028. ub4 offset,
  4029. ub4 *amtp,
  4030. dvoid *bufp,
  4031. ub4 buflen,
  4032. ub1 piece,
  4033. dvoid *ctxp,
  4034. OCICallbackLobWrite (cbfp)
  4035. (
  4036. dvoid *ctxp,
  4037. dvoid *bufp,
  4038. ub4 *lenp,
  4039. ub1 *piecep )
  4040. ub2 csid
  4041. ub1 csfrm );
  4042. Comments
  4043. Writes a buffer into a LOB as specified. If LOB data already exists
  4044. it is overwritten with the data stored in the buffer.
  4045. The buffer can be written to the LOB in a single piece with this call, or
  4046. it can be provided piecewise using callbacks or a standard polling method.
  4047. If this value of the piece parameter is OCI_FIRST_PIECE, data must be
  4048. provided through callbacks or polling.
  4049. If a callback function is defined in the cbfp parameter, then this callback
  4050. function will be invoked to get the next piece after a piece is written to
  4051. the pipe. Each piece will be written from bufp.
  4052. If no callback function is defined, then OCILobWrite() returns the
  4053. OCI_NEED_DATA error code. The application must all OCILobWrite() again
  4054. to write more pieces of the LOB. In this mode, the buffer pointer and the
  4055. length can be different in each call if the pieces are of different sizes and
  4056. from different locations. A piece value of OCI_LAST_PIECE terminates the
  4057. piecewise write.
  4058. Parameters
  4059. svchp (IN/OUT) - the service context handle.
  4060. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  4061. diagnostic information in the event of an error.
  4062. locp (IN/OUT) - a LOB locator that uniquely references a LOB.
  4063. offset (IN) - On input, it is the absolute offset, for character LOBs in
  4064. the number of characters from the beginning of the LOB, for binary LOBs it
  4065. is the number of bytes. Starts at 1.
  4066. bufp (IN) - the pointer to a buffer from which the piece will be written. The
  4067. length of the allocated memory is assumed to be the value passed in bufl.
  4068. Even if the data is being written in pieces, bufp must contain the first
  4069. piece of the LOB when this call is invoked.
  4070. bufl (IN) - the length of the buffer in bytes.
  4071. Note: This parameter assumes an 8-bit byte. If your platform uses a
  4072. longer byte, the value of bufl must be adjusted accordingly.
  4073. piece (IN) - which piece of the buffer is being written. The default value for
  4074. this parameter is OCI_ONE_PIECE, indicating the buffer will be written in a
  4075. single piece.
  4076. The following other values are also possible for piecewise or callback mode:
  4077. OCI_FIRST_PIECE, OCI_NEXT_PIECE and OCI_LAST_PIECE.
  4078. amtp (IN/OUT) - On input, takes the number of character or bytes to be
  4079. written. On output, returns the actual number of bytes or characters written.
  4080. If the data is written in pieces, *amtp will contain the total length of the
  4081. pieces written at the end of the call (last piece written) and is undefined in
  4082. between.
  4083. (Note it is different from the piecewise read case)
  4084. ctxp (IN) - the context for the call back function. Can be NULL.
  4085. cbfp (IN) - a callback that may be registered to be called for each piece in
  4086. a piecewise write. If this is NULL, the standard polling method will be used.
  4087. The callback function must return OCI_CONTINUE for the write to continue.
  4088. If any other error code is returned, the LOB write is aborted. The
  4089. callback takes the following parameters:
  4090. ctxp (IN) - the context for the call back function. Can be NULL.
  4091. bufp (IN/OUT) - a buffer pointer for the piece.
  4092. lenp (IN/OUT) - the length of the buffer (in octets) and the length of
  4093. current piece in bufp (out octets).
  4094. piecep (OUT) - which piece - OCI_NEXT_PIECE or OCI_LAST_PIECE.
  4095. csid - the character set ID of the buffer data
  4096. csfrm - the character set form of the buffer data
  4097. Related Functions
  4098. OCILobWriteAppend()
  4099. Name
  4100. OCI Lob Write Append
  4101. Purpose
  4102. Writes data to the end of a LOB value. This call provides the ability
  4103. to get the length of the data and append it to the end of the LOB in
  4104. a single round trip to the server.
  4105. Syntax
  4106. sword OCILobWriteAppend ( OCISvcCtx *svchp,
  4107. OCIError *errhp,
  4108. OCILobLocator *locp,
  4109. ub4 *amtp,
  4110. dvoid *bufp,
  4111. ub4 buflen,
  4112. ub1 piece,
  4113. dvoid *ctxp,
  4114. OCICallbackLobWrite (cbfp)
  4115. (
  4116. dvoid *ctxp,
  4117. dvoid *bufp,
  4118. ub4 *lenp,
  4119. ub1 *piecep )
  4120. ub2 csid
  4121. ub1 csfrm );
  4122. Comments
  4123. Writes a buffer to the end of a LOB as specified. If LOB data already exists
  4124. it is overwritten with the data stored in the buffer.
  4125. The buffer can be written to the LOB in a single piece with this call, or
  4126. it can be provided piecewise using callbacks or a standard polling method.
  4127. If this value of the piece parameter is OCI_FIRST_PIECE, data must be
  4128. provided through callbacks or polling.
  4129. If a callback function is defined in the cbfp parameter, then this callback
  4130. function will be invoked to get the next piece after a piece is written to the
  4131. pipe. Each piece will be written from bufp.
  4132. If no callback function is defined, then OCILobWriteAppend() returns the
  4133. OCI_NEED_DATA error code. The application must all OCILobWriteAppend() again
  4134. to write more pieces of the LOB. In this mode, the buffer pointer and the
  4135. length can be different in each call if the pieces are of different sizes and
  4136. from different locations. A piece value of OCI_LAST_PIECE terminates the
  4137. piecewise write.
  4138. Parameters
  4139. svchp (IN/OUT) - the service context handle.
  4140. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  4141. diagnostic information in the event of an error.
  4142. locp (IN/OUT) - a LOB locator that uniquely references a LOB.
  4143. bufp (IN) - the pointer to a buffer from which the piece will be written. The
  4144. length of the allocated memory is assumed to be the value passed in bufl. Even
  4145. if the data is being written in pieces, bufp must contain the first piece of
  4146. the LOB when this call is invoked.
  4147. bufl (IN) - the length of the buffer in bytes.
  4148. Note: This parameter assumes an 8-bit byte. If your platform uses a
  4149. longer byte, the value of bufl must be adjusted accordingly.
  4150. piece (IN) - which piece of the buffer is being written. The default value for
  4151. this parameter is OCI_ONE_PIECE, indicating the buffer will be written in a
  4152. single piece.
  4153. The following other values are also possible for piecewise or callback mode:
  4154. OCI_FIRST_PIECE, OCI_NEXT_PIECE and OCI_LAST_PIECE.
  4155. amtp (IN/OUT) - On input, takes the number of character or bytes to be
  4156. written. On output, returns the actual number of bytes or characters written.
  4157. If the data is written in pieces, *amtp will contain the total length of the
  4158. pieces written at the end of the call (last piece written) and is undefined in
  4159. between.
  4160. (Note it is different from the piecewise read case)
  4161. ctxp (IN) - the context for the call back function. Can be NULL.
  4162. cbfp (IN) - a callback that may be registered to be called for each piece in a
  4163. piecewise write. If this is NULL, the standard polling method will be used.
  4164. The callback function must return OCI_CONTINUE for the write to continue.
  4165. If any other error code is returned, the LOB write is aborted. The
  4166. callback takes the following parameters:
  4167. ctxp (IN) - the context for the call back function. Can be NULL.
  4168. bufp (IN/OUT) - a buffer pointer for the piece.
  4169. lenp (IN/OUT) - the length of the buffer (in octets) and the length of
  4170. current piece in bufp (out octets).
  4171. piecep (OUT) - which piece - OCI_NEXT_PIECE or OCI_LAST_PIECE.
  4172. csid - the character set ID of the buffer data
  4173. csfrm - the character set form of the buffer data
  4174. Related Functions
  4175. OCILobGetStorageLimit()
  4176. Name
  4177. OCI Lob Get Storage Limit
  4178. Purpose
  4179. To get the maximum Length of a LOB in bytes that can be stored in the database.
  4180. Syntax
  4181. sword OCILobGetStorageLimit ( OCISvcCtx *svchp,
  4182. OCIError *errhp,
  4183. OCILobLocator *locp,
  4184. oraub8 *limitp);
  4185. Comments
  4186. With unlimited size LOB support the limit for a LOB is no longer restricted to 4GB.
  4187. This interface should be used to get the actual limit for storing data for a specific
  4188. LOB locator. Note that if the compatibality is set to 9.2 or older the limit would still
  4189. be 4GB.
  4190. Parameters
  4191. svchp (IN/OUT) - the service context handle.
  4192. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  4193. diagnostic information in the event of an error.
  4194. locp (IN/OUT) - a LOB locator that uniquely references a LOB.
  4195. limitp (OUT) - The storage limit for a LOB in bytes.
  4196. Related Functions
  4197. OCILogoff()
  4198. Name
  4199. OCI simplified Logoff
  4200. Purpose
  4201. This function is used to terminate a session created with OCILogon() or
  4202. OCILogon2().
  4203. Syntax
  4204. sword OCILogoff ( OCISvcCtx *svchp
  4205. OCIError *errhp );
  4206. Comments
  4207. This call is used to terminate a session which was created with OCILogon() or
  4208. OCILogon2().
  4209. This call implicitly deallocates the server, authentication, and service
  4210. context handles.
  4211. Note: For more information on logging on and off in an application,
  4212. refer to the section "Application Initialization, Connection, and
  4213. Authorization" on page 2-16.
  4214. Parameters
  4215. svchp (IN) - the service context handle which was used in the call to
  4216. OCILogon() or OCILogon2().
  4217. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  4218. diagnostic information in the event of an error.
  4219. See Also
  4220. OCILogon(), OCILogon2().
  4221. OCILogon()
  4222. Name
  4223. OCI Service Context Logon
  4224. Purpose
  4225. This function is used to create a simple logon session.
  4226. Syntax
  4227. sword OCILogon ( OCIEnv *envhp,
  4228. OCIError *errhp,
  4229. OCISvcCtx *svchp,
  4230. CONST OraText *username,
  4231. ub4 uname_len,
  4232. CONST OraText *password,
  4233. ub4 passwd_len,
  4234. CONST OraText *dbname,
  4235. ub4 dbname_len );
  4236. Comments
  4237. This function is used to create a simple logon session for an application.
  4238. Note: Users requiring more complex session (e.g., TP monitor
  4239. applications) should refer to the section "Application Initialization,
  4240. Connection, and Authorization" on page 2-16.
  4241. This call allocates the error and service context handles which are passed to
  4242. it. This call also implicitly allocates server and authentication handles
  4243. associated with the session. These handles can be retrieved by calling
  4244. OCIAttrGet() on the service context handle.
  4245. Parameters
  4246. envhp (IN) - the OCI environment handle.
  4247. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  4248. diagnostic information in the event of an error.
  4249. svchp (OUT) - the service context pointer.
  4250. username (IN) - the username.
  4251. uname_len (IN) - the length of username.
  4252. password (IN) - the user's password.
  4253. passwd_len (IN) - the length of password.
  4254. dbname (IN) - the name of the database to connect to.
  4255. dbname_len (IN) - the length of dbname.
  4256. See Also
  4257. OCILogoff()
  4258. OCILogon2()
  4259. Name
  4260. OCI Service Context Logon
  4261. Purpose
  4262. This function is used to create a logon session in connection pooling mode.
  4263. Syntax
  4264. sword OCILogon2 ( OCIEnv *envhp,
  4265. OCIError *errhp,
  4266. OCISvcCtx **svchp,
  4267. CONST OraText *username,
  4268. ub4 uname_len,
  4269. CONST OraText *password,
  4270. ub4 passwd_len,
  4271. CONST OraText *dbname,
  4272. ub4 dbname_len,
  4273. ub4 mode);
  4274. Comments
  4275. This function is used to create a simple logon session for an application in
  4276. Connection Pooling mode. The valid values for mode are currently OCI_POOL and
  4277. OCI_DEFAULT. Call to this function with OCI_DEFAULT mode is equivalent to
  4278. OCILogon() call.
  4279. This call allocates the error and service context handles which are passed to
  4280. it. This call also implicitly allocates server and authentication handles
  4281. associated with the session. These handles can be retrieved by calling
  4282. OCIAttrGet() on the service context handle. This call assumes that
  4283. OCIConnectionPoolCreate() has already been called for the same dbname.
  4284. Parameters
  4285. envhp (IN) - the OCI environment handle.
  4286. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  4287. diagnostic information in the event of an error.
  4288. svchp (OUT) - the service context pointer.
  4289. username (IN) - the username.
  4290. uname_len (IN) - the length of username.
  4291. password (IN) - the user's password. If this is null, it is assumed that a
  4292. proxy session has to be created and the required grants on
  4293. the database are already done.
  4294. passwd_len (IN) - the length of password.
  4295. dbname (IN) - the name of the database to connect to.
  4296. dbname_len (IN) - the length of dbname.
  4297. mode (IN) - the mode for doing the server attach. Should be OCI_POOL for
  4298. using Connection Pooling.
  4299. See Also
  4300. OCILogoff()
  4301. OCIMemoryFree()
  4302. Name
  4303. OCI FREE Memory
  4304. Purpose
  4305. Frees up storage associated with the pointer.
  4306. Syntax
  4307. void OCIMemoryFree ( CONST OCIStmt *stmhp,
  4308. dvoid *memptr);
  4309. Comments
  4310. Frees up dynamically allocated data pointers associated with the pointer using
  4311. either the default memory free function or the registered memory free
  4312. function, as the case may be.
  4313. A user-defined memory free function can be registered during the initial call
  4314. to OCIInitialize().
  4315. This call is always successful.
  4316. Parameters
  4317. stmhp (IN) - statement handle which returned this data buffer.
  4318. memptr (IN) - pointer to data allocated by the client library.
  4319. Related Functions
  4320. OCIInitialize()
  4321. OCIParamGet()
  4322. Name
  4323. OCI Get PARaMeter
  4324. Purpose
  4325. Returns a descriptor of a parameter specified by position in the describe
  4326. handle or statement handle.
  4327. Syntax
  4328. sword OCIParamGet ( CONST dvoid *hndlp,
  4329. ub4 htype,
  4330. OCIError *errhp,
  4331. dvoid **parmdpp,
  4332. ub4 pos );
  4333. Comments
  4334. This call returns a descriptor of a parameter specified by position in the
  4335. describe handle or statement handle. Parameter descriptors are always
  4336. allocated internally by the OCI library. They are read-only.
  4337. OCI_NO_DATA may be returned if there are no parameter descriptors for this
  4338. position.
  4339. See Appendix B for more detailed information about parameter descriptor
  4340. attributes.
  4341. Parameters
  4342. hndlp (IN) - a statement handle or describe handle. The OCIParamGet()
  4343. function will return a parameter descriptor for this handle.
  4344. htype (IN) - the type of the handle passed in the handle parameter. Valid
  4345. types are OCI_HTYPE_DESCRIBE, for a describe handle OCI_HTYPE_STMT, for a
  4346. statement handle
  4347. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  4348. diagnostic information in the event of an error.
  4349. parmdpp (OUT) - a descriptor of the parameter at the position given in the pos
  4350. parameter.
  4351. pos (IN) - position number in the statement handle or describe handle. A
  4352. parameter descriptor will be returned for this position.
  4353. Note: OCI_NO_DATA may be returned if there are no parameter
  4354. descriptors for this position.
  4355. Related Functions
  4356. OCIAttrGet(), OCIAttrSet()
  4357. OCIParamSet()
  4358. Name
  4359. OCI Parameter Set in handle
  4360. Purpose
  4361. Used to set a complex object retrieval descriptor into a complex object
  4362. retrieval handle.
  4363. Syntax
  4364. sword OCIParamGet ( dvoid *hndlp,
  4365. ub4 htyp,
  4366. OCIError *errhp,
  4367. CONST dvoid *dscp,
  4368. ub4 dtyp,
  4369. ub4 pos );
  4370. Comments
  4371. This call sets a given complex object retrieval descriptor into a complex
  4372. object retrieval handle.
  4373. The handle must have been previously allocated using OCIHandleAlloc(), and
  4374. the descriptor must have been previously allocated using OCIDescAlloc().
  4375. Attributes of the descriptor are set using OCIAttrSet().
  4376. Parameters
  4377. hndlp (IN/OUT) - handle pointer.
  4378. htype (IN) - handle type.
  4379. errhp (IN/OUT) - error handle.
  4380. dscp (IN) - complex object retrieval descriptor pointer.
  4381. dtyp (IN) -
  4382. pos (IN) - position number.
  4383. See Also
  4384. OCIPasswordChange()
  4385. Name
  4386. OCI Change PassWord
  4387. Purpose
  4388. This call allows the password of an account to be changed.
  4389. Syntax
  4390. sword OCIPasswordChange ( OCISvcCtx *svchp,
  4391. OCIError *errhp,
  4392. CONST OraText *user_name,
  4393. ub4 usernm_len,
  4394. CONST OraText *opasswd,
  4395. ub4 opasswd_len,
  4396. CONST OraText *npasswd,
  4397. sb4 npasswd_len,
  4398. ub4 mode);
  4399. Comments
  4400. This call allows the password of an account to be changed. This call is
  4401. similar to OCISessionBegin() with the following differences:
  4402. If the user authentication is already established, it authenticates
  4403. the account using the old password and then changes the
  4404. password to the new password
  4405. If the user authentication is not established, it establishes a user
  4406. authentication and authenticates the account using the old
  4407. password, then changes the password to the new password.
  4408. This call is useful when the password of an account is expired and
  4409. OCISessionBegin() returns an error or warning which indicates that the
  4410. password has expired.
  4411. Parameters
  4412. svchp (IN/OUT) - a handle to a service context. The service context handle
  4413. must be initialized and have a server context handle associated with it.
  4414. errhp (IN) - an error handle which can be passed to OCIErrorGet() for
  4415. diagnostic information in the event of an error.
  4416. user_name (IN) - specifies the user name. It points to a character string,
  4417. whose length is specified in usernm_len. This parameter must be NULL if the
  4418. service context has been initialized with an authentication handle.
  4419. usernm_len (IN) - the length of the user name string specified in user_name.
  4420. For a valid user name string, usernm_len must be non-zero.
  4421. opasswd (IN) - specifies the user's old password. It points to a character
  4422. string, whose length is specified in opasswd_len .
  4423. opasswd_len (IN) - the length of the old password string specified in opasswd.
  4424. For a valid password string, opasswd_len must be non-zero.
  4425. npasswd (IN) - specifies the user's new password. It points to a character
  4426. string, whose length is specified in npasswd_len which must be non-zero for a
  4427. valid password string. If the password complexity verification routine is
  4428. specified in the user's profile to verify the new password's complexity, the
  4429. new password must meet the complexity requirements of the verification
  4430. function.
  4431. npasswd_len (IN) - then length of the new password string specified in
  4432. npasswd. For a valid password string, npasswd_len must be non-zero.
  4433. mode - pass as OCI_DEFAULT.
  4434. Related Functions
  4435. OCISessionBegin()
  4436. ----------------------------------OCIReset------------------------------------
  4437. OCIReset()
  4438. Name
  4439. OCI Reset
  4440. Purpose
  4441. Resets the interrupted asynchronous operation and protocol. Must be called
  4442. if a OCIBreak call had been issued while a non-blocking operation was in
  4443. progress.
  4444. Syntax
  4445. sword OCIReset ( dvoid *hndlp,
  4446. OCIError *errhp);
  4447. Comments
  4448. This call is called in non-blocking mode ONLY. Resets the interrupted
  4449. asynchronous operation and protocol. Must be called if a OCIBreak call
  4450. had been issued while a non-blocking operation was in progress.
  4451. Parameters
  4452. hndlp (IN) - the service context handle or the server context handle.
  4453. errhp (IN) - an error handle which can be passed to OCIErrorGet() for
  4454. diagnostic information in the event of an error.
  4455. Related Functions
  4456. OCIResultSetToStmt()
  4457. Name
  4458. OCI convert Result Set to Statement Handle
  4459. Purpose
  4460. Converts a descriptor to statement handle for fetching rows.
  4461. Syntax
  4462. sword OCIResultSetToStmt ( OCIResult *rsetdp,
  4463. OCIError *errhp );
  4464. Comments
  4465. Converts a descriptor to statement handle for fetching rows.
  4466. A result set descriptor can be allocated with a call to OCIDescAlloc().
  4467. Parameters
  4468. rsetdp (IN/OUT) - a result set descriptor pointer.
  4469. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  4470. diagnostic information in the event of an error.
  4471. Related Functions
  4472. OCIDescAlloc()
  4473. OCIServerAttach()
  4474. Name
  4475. OCI ATtaCH to server
  4476. Purpose
  4477. Creates an access path to a data source for OCI operations.
  4478. Syntax
  4479. sword OCIServerAttach ( OCIServer *srvhp,
  4480. OCIError *errhp,
  4481. CONST OraText *dblink,
  4482. sb4 dblink_len,
  4483. ub4 mode);
  4484. Comments
  4485. This call is used to create an association between an OCI application and a
  4486. particular server.
  4487. This call initializes a server context handle, which must have been previously
  4488. allocated with a call to OCIHandleAlloc().
  4489. The server context handle initialized by this call can be associated with a
  4490. service context through a call to OCIAttrSet(). Once that association has been
  4491. made, OCI operations can be performed against the server.
  4492. If an application is operating against multiple servers, multiple server
  4493. context handles can be maintained. OCI operations are performed against
  4494. whichever server context is currently associated with the service context.
  4495. Parameters
  4496. srvhp (IN/OUT) - an uninitialized server context handle, which gets
  4497. initialized by this call. Passing in an initialized server handle causes an
  4498. error.
  4499. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  4500. diagnostic information in the event of an error.
  4501. dblink (IN) - specifies the database (server) to use. This parameter points to
  4502. a character string which specifies a connect string or a service point. If the
  4503. connect string is NULL, then this call attaches to the default host. The length
  4504. of connstr is specified in connstr_len. The connstr pointer may be freed by the
  4505. caller on return.
  4506. dblink_len (IN) - the length of the string pointed to by connstr. For a valid
  4507. connect string name or alias, connstr_len must be non-zero.
  4508. mode (IN) - specifies the various modes of operation. For release 8.0, pass as
  4509. OCI_DEFAULT - in this mode, calls made to the server on this server context
  4510. are made in blocking mode.
  4511. Example
  4512. See the description of OCIStmtPrepare() on page 13-96 for an example showing
  4513. the use of OCIServerAttach().
  4514. Related Functions
  4515. OCIServerDetach()
  4516. OCIServerDetach()
  4517. Name
  4518. OCI DeTaCH server
  4519. Purpose
  4520. Deletes an access to a data source for OCI operations.
  4521. Syntax
  4522. sword OCIServerDetach ( OCIServer *svrhp,
  4523. OCIError *errhp,
  4524. ub4 mode);
  4525. Comments
  4526. This call deletes an access to data source for OCI operations, which was
  4527. established by a call to OCIServerAttach().
  4528. Parameters
  4529. srvhp (IN) - a handle to an initialized server context, which gets reset to
  4530. uninitialized state. The handle is not de-allocated.
  4531. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  4532. diagnostic information in the event of an error.
  4533. mode (IN) - specifies the various modes of operation. The only valid mode is
  4534. OCI_DEFAULT for the default mode.
  4535. Related Functions
  4536. OCIServerAttach()
  4537. OCIServerVersion()
  4538. Name
  4539. OCI VERSion
  4540. Purpose
  4541. Returns the version string of the Oracle server.
  4542. Syntax
  4543. sword OCIServerVersion ( dvoid *hndlp,
  4544. OCIError *errhp,
  4545. OraText *bufp,
  4546. ub4 bufsz
  4547. ub1 hndltype );
  4548. Comments
  4549. This call returns the version string of the Oracle server.
  4550. For example, the following might be returned as the version string if your
  4551. application is running against a 7.3.2 server:
  4552. Oracle7 Server Release 7.3.2.0.0 - Production Release
  4553. PL/SQL Release 2.3.2.0.0 - Production
  4554. CORE Version 3.5.2.0.0 - Production
  4555. TNS for SEQUENT DYNIX/ptx: Version 2.3.2.0.0 - Production
  4556. NLSRTL Version 3.2.2.0.0 - Production
  4557. Parameters
  4558. hndlp (IN) - the service context handle or the server context handle.
  4559. errhp (IN) - an error handle which can be passed to OCIErrorGet() for
  4560. diagnostic information in the event of an error.
  4561. bufp (IN) - the buffer in which the version information is returned.
  4562. bufsz (IN) - the length of the buffer.
  4563. hndltype (IN) - the type of handle passed to the function.
  4564. Related Functions
  4565. OCISessionBegin()
  4566. Name
  4567. OCI Session Begin and authenticate user
  4568. Purpose
  4569. Creates a user authentication and begins a user session for a given server.
  4570. Syntax
  4571. sword OCISessionBegin ( OCISvcCtx *svchp,
  4572. OCIError *errhp,
  4573. OCISession *usrhp,
  4574. ub4 credt,
  4575. ub4 mode);
  4576. Comments
  4577. For Oracle8, OCISessionBegin() must be called for any given server handle
  4578. before requests can be made against it. Also, OCISessionBegin() only supports
  4579. authenticating the user for access to the Oracle server specified by the
  4580. server handle in the service context. In other words, after OCIServerAttach()
  4581. is called to initialize a server handle, OCISessionBegin() must be called to
  4582. authenticate the user for that given server.
  4583. When OCISessionBegin() is called for the first time for the given server
  4584. handle, the initialized authentication handle is called a primary
  4585. authentication context. A primary authentication context may not be created
  4586. with the OCI_MIGRATE mode. Also, only one primary authentication context can
  4587. be created for a given server handle and the primary authentication context c
  4588. an only ever be used with that server handle. If the primary authentication
  4589. context is set in a service handle with a different server handle, then an
  4590. error will result.
  4591. After OCISessionBegin() has been called for the server handle, and the primary
  4592. authentication context is set in the service handle, OCISessionBegin() may be
  4593. called again to initialize another authentication handle with different (or
  4594. the same) credentials. When OCISessionBegin() is called with a service handle
  4595. set with a primary authentication context, the returned authentication context
  4596. in authp is called a user authentication context. As many user authentication
  4597. contexts may be initialized as desired.
  4598. User authentication contexts may be created with the OCI_MIGRATE mode.
  4599. If the OCI_MIGRATE mode is not specified, then the user authentication
  4600. context can only ever be used with the same server handle set in svchp. If
  4601. OCI_MIGRATE mode is specified, then the user authentication may be set
  4602. with different server handles. However, the user authentication context is
  4603. restricted to use with only server handles which resolve to the same database
  4604. instance and that have equivalent primary authentication contexts. Equivalent
  4605. authentication contexts are those which were authenticated as the same
  4606. database user.
  4607. OCI_SYSDBA, OCI_SYSOPER, and OCI_PRELIM_AUTH may only be used
  4608. with a primary authentication context.
  4609. To provide credentials for a call to OCISessionBegin(), one of two methods are
  4610. supported. The first is to provide a valid username and password pair for
  4611. database authentication in the user authentication handle passed to
  4612. OCISessionBegin(). This involves using OCIAttrSet() to set the
  4613. OCI_ATTR_USERNAME and OCI_ATTR_PASSWORD attributes on the
  4614. authentication handle. Then OCISessionBegin() is called with
  4615. OCI_CRED_RDBMS.
  4616. Note: When the authentication handle is terminated using
  4617. OCISessionEnd(), the username and password attributes remain
  4618. unchanged and thus can be re-used in a future call to OCISessionBegin().
  4619. Otherwise, they must be reset to new values before the next
  4620. OCISessionBegin() call.
  4621. The second type of credentials supported are external credentials. No
  4622. attributes need to be set on the authentication handle before calling
  4623. OCISessionBegin(). The credential type is OCI_CRED_EXT. This is equivalent
  4624. to the Oracle7 `connect /' syntax. If values have been set for
  4625. OCI_ATTR_USERNAME and OCI_ATTR_PASSWORD, then these are
  4626. ignored if OCI_CRED_EXT is used.
  4627. Parameters
  4628. svchp (IN) - a handle to a service context. There must be a valid server
  4629. handle set in svchp.
  4630. errhp (IN) - an error handle to the retrieve diagnostic information.
  4631. usrhp (IN/OUT) - a handle to an authentication context, which is initialized
  4632. by this call.
  4633. credt (IN) - specifies the type of credentials to use for authentication.
  4634. Valid values for credt are:
  4635. OCI_CRED_RDBMS - authenticate using a database username and
  4636. password pair as credentials. The attributes OCI_ATTR_USERNAME
  4637. and OCI_ATTR_PASSWORD should be set on the authentication
  4638. context before this call.
  4639. OCI_CRED_EXT - authenticate using external credentials. No username
  4640. or password is provided.
  4641. mode (IN) - specifies the various modes of operation. Valid modes are:
  4642. OCI_DEFAULT - in this mode, the authentication context returned may
  4643. only ever be set with the same server context specified in svchp. This
  4644. establishes the primary authentication context.
  4645. OCI_MIGRATE - in this mode, the new authentication context may be
  4646. set in a service handle with a different server handle. This mode
  4647. establishes the user authentication context.
  4648. OCI_SYSDBA - in this mode, the user is authenticated for SYSDBA
  4649. access.
  4650. OCI_SYSOPER - in this mode, the user is authenticated for SYSOPER
  4651. access.
  4652. OCI_PRELIM_AUTH - this mode may only be used with OCI_SYSDBA
  4653. or OCI_SYSOPER to authenticate for certain administration tasks.
  4654. Related Functions
  4655. OCISessionEnd()
  4656. OCISessionEnd()
  4657. Name
  4658. OCI Terminate user Authentication Context
  4659. Purpose
  4660. Terminates a user authentication context created by OCISessionBegin()
  4661. Syntax
  4662. sword OCISessionEnd ( OCISvcCtx *svchp,
  4663. OCIError *errhp,
  4664. OCISession *usrhp,
  4665. ub4 mode);
  4666. Comments
  4667. The user security context associated with the service context is invalidated
  4668. by this call. Storage for the authentication context is not freed. The
  4669. transaction specified by the service context is implicitly committed. The
  4670. transaction handle, if explicitly allocated, may be freed if not being used.
  4671. Resources allocated on the server for this user are freed.
  4672. The authentication handle may be reused in a new call to OCISessionBegin().
  4673. Parameters
  4674. svchp (IN/OUT) - the service context handle. There must be a valid server
  4675. handle and user authentication handle associated with svchp.
  4676. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  4677. diagnostic information in the event of an error.
  4678. usrhp (IN) - de-authenticate this user. If this parameter is passed as NULL,
  4679. the user in the service context handle is de-authenticated.
  4680. mode (IN) - the only valid mode is OCI_DEFAULT.
  4681. Example
  4682. In this example, an authentication context is destroyed.
  4683. Related Functions
  4684. OCISessionBegin()
  4685. OCIStmtExecute()
  4686. Name
  4687. OCI EXECute
  4688. Purpose
  4689. This call associates an application request with a server.
  4690. Syntax
  4691. sword OCIStmtExecute ( OCISvcCtx *svchp,
  4692. OCIStmt *stmtp,
  4693. OCIError *errhp,
  4694. ub4 iters,
  4695. ub4 rowoff,
  4696. CONST OCISnapshot *snap_in,
  4697. OCISnapshot *snap_out,
  4698. ub4 mode );
  4699. Comments
  4700. This function is used to execute a prepared SQL statement.
  4701. Using an execute call, the application associates a request with a server. On
  4702. success, OCI_SUCCESS is returned.
  4703. If a SELECT statement is executed, the description of the select list follows
  4704. implicitly as a response. This description is buffered on the client side for
  4705. describes, fetches and define type conversions. Hence it is optimal to
  4706. describe a select list only after an execute.
  4707. Also for SELECT statements, some results are available implicitly. Rows will
  4708. be received and buffered at the end of the execute. For queries with small row
  4709. count, a prefetch causes memory to be released in the server if the end of
  4710. fetch is reached, an optimization that may result in memory usage reduction.
  4711. Set attribute call has been defined to set the number of rows to be prefetched
  4712. per result set.
  4713. For SELECT statements, at the end of the execute, the statement handle
  4714. implicitly maintains a reference to the service context on which it is
  4715. executed. It is the user's responsibility to maintain the integrity of the
  4716. service context. If the attributes of a service context is changed for
  4717. executing some operations on this service context, the service context must
  4718. be restored to have the same attributes, that a statement was executed with,
  4719. prior to a fetch on the statement handle. The implicit reference is maintained
  4720. until the statement handle is freed or the fetch is cancelled or an end of
  4721. fetch condition is reached.
  4722. Note: If output variables are defined for a SELECT statement before a
  4723. call to OCIStmtExecute(), the number of rows specified by iters will be
  4724. fetched directly into the defined output buffers and additional rows
  4725. equivalent to the prefetch count will be prefetched. If there are no
  4726. additional rows, then the fetch is complete without calling
  4727. OCIStmtFetch().
  4728. The execute call will return errors if the statement has bind data types that
  4729. are not supported in an Oracle7 server.
  4730. Parameters
  4731. svchp (IN/OUT) - service context handle.
  4732. stmtp (IN/OUT) - an statement handle - defines the statement and the
  4733. associated data to be executed at the server. It is invalid to pass in a
  4734. statement handle that has bind of data types only supported in release 8.0
  4735. when srvchp points to an Oracle7 server.
  4736. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  4737. diagnostic information in the event of an error. If the statement is being
  4738. batched and it is successful, then this handle will contain this particular
  4739. statement execution specific errors returned from the server when the batch is
  4740. flushed.
  4741. iters (IN) - the number of times this statement is executed for non-Select
  4742. statements. For Select statements, if iters is non-zero, then defines must
  4743. have been done for the statement handle. The execution fetches iters rows into
  4744. these predefined buffers and prefetches more rows depending upon the prefetch
  4745. row count. This function returns an error if iters=0 for non-SELECT
  4746. statements.
  4747. rowoff (IN) - the index from which the data in an array bind is relevant for
  4748. this multiple row execution.
  4749. snap_in (IN) - this parameter is optional. if supplied, must point to a
  4750. snapshot descriptor of type OCI_DTYPE_SNAP. The contents of this descriptor
  4751. must be obtained from the snap_out parameter of a previous call. The
  4752. descriptor is ignored if the SQL is not a SELECT. This facility allows
  4753. multiple service contexts to ORACLE to see the same consistent snapshot of the
  4754. database's committed data. However, uncommitted data in one context is not
  4755. visible to another context even using the same snapshot.
  4756. snap_out (OUT) - this parameter optional. if supplied, must point to a
  4757. descriptor of type OCI_DTYPE_SNAP. This descriptor is filled in with an
  4758. opaque representation which is the current ORACLE "system change
  4759. number" suitable as a snap_in input to a subsequent call to OCIStmtExecute().
  4760. This descriptor should not be used any longer than necessary in order to avoid
  4761. "snapshot too old" errors.
  4762. mode (IN) - The modes are:
  4763. If OCI_DEFAULT_MODE, the default mode, is selected, the request is
  4764. immediately executed. Error handle contains diagnostics on error if any.
  4765. OCI_EXACT_FETCH - if the statement is a SQL SELECT, this mode is
  4766. only valid if the application has set the prefetch row count prior to this
  4767. call. In this mode, the OCI library will get up to the number of rows
  4768. specified (i.e., prefetch row count plus iters). If the number of rows
  4769. returned by the query is greater than this value, OCI_ERROR will be
  4770. returned with ORA-01422 as the implementation specific error in a
  4771. diagnostic record. If the number of rows returned by the query is
  4772. smaller than the prefetch row count, OCI_SUCCESS_WITH_INFO will
  4773. be returned with ORA-01403 as the implementation specific error. The
  4774. prefetch buffer size is ignored and the OCI library tries to allocate all the
  4775. space required to contain the prefetched rows. The exact fetch semantics
  4776. apply to only the top level rows. No more rows can be fetched for this
  4777. query at the end of the call.
  4778. OCI_KEEP_FETCH_STATE - the result set rows (not yet fetched) of this
  4779. statement executed in this transaction will be maintained when the
  4780. transaction is detached for migration. By default, a query is cancelled
  4781. when a transaction is detached for migration. This mode is the default
  4782. mode when connected to a V7 server.
  4783. Related Functions
  4784. OCIStmtPrepare()
  4785. OCIStmtFetch()
  4786. Name
  4787. OCI FetCH
  4788. Purpose
  4789. Fetches rows from a query.
  4790. Syntax
  4791. sword OCIStmtFetch ( OCIStmt *stmtp,
  4792. OCIError *errhp,
  4793. ub4 nrows,
  4794. ub2 orientation,
  4795. ub4 mode);
  4796. Comments
  4797. The fetch call is a local call, if prefetched rows suffice. However, this is
  4798. transparent to the application. If LOB columns are being read, LOB locators
  4799. are fetched for subsequent LOB operations to be performed on these locators.
  4800. Prefetching is turned off if LONG columns are involved.
  4801. A fetch with nrows set to 0 rows effectively cancels the fetch for this
  4802. statement.
  4803. Parameters
  4804. stmtp (IN) - a statement (application request) handle.
  4805. errhp (IN) - an error handle which can be passed to OCIErrorGet() for
  4806. diagnostic information in the event of an error.
  4807. nrows (IN) - number of rows to be fetched from the current position.
  4808. orientation (IN) - for release 8.0, the only acceptable value is
  4809. OCI_FETCH_NEXT, which is also the default value.
  4810. mode (IN) - for release 8.0, beta-1, the following mode is defined.
  4811. OCI_DEFAULT - default mode
  4812. OCI_EOF_FETCH - indicates that it is the last fetch from the result set.
  4813. If nrows is non-zero, setting this mode effectively cancels fetching after
  4814. retrieving nrows, otherwise it cancels fetching immediately.
  4815. Related Functions
  4816. OCIAttrGet()
  4817. OCIStmtFetch2()
  4818. Name
  4819. OCI FetCH2
  4820. Purpose
  4821. Fetches rows from a query.
  4822. Syntax
  4823. sword OCIStmtFetch2 ( OCIStmt *stmtp,
  4824. OCIError *errhp,
  4825. ub4 nrows,
  4826. ub2 orientation,
  4827. ub4 scrollOffset,
  4828. ub4 mode);
  4829. Comments
  4830. The fetch call works similar to the OCIStmtFetch call with the
  4831. addition of the fetchOffset parameter. It can be used on any
  4832. statement handle, whether it is scrollable or not. For a
  4833. non-scrollable statement handle, the only acceptable value
  4834. will be OCI_FETCH_NEXT, and the fetchOffset parameter will be
  4835. ignored. Applications are encouraged to use this new call.
  4836. A fetchOffset with OCI_FETCH_RELATIVE is equivalent to
  4837. OCI_FETCH_CURRENT with a value of 0, is equivalent to
  4838. OCI_FETCH_NEXT with a value of 1, and equivalent to
  4839. OCI_FETCH_PRIOR with a value of -1. Note that the range of
  4840. accessible rows is [1,OCI_ATTR_ROW_COUNT] beyond which an
  4841. error could be raised if sufficient rows do not exist in
  4842. The fetch call is a local call, if prefetched rows suffice. However, this is
  4843. transparent to the application. If LOB columns are being read, LOB locators
  4844. are fetched for subsequent LOB operations to be performed on these locators.
  4845. Prefetching is turned off if LONG columns are involved.
  4846. A fetch with nrows set to 0 rows effectively cancels the fetch for this
  4847. statement.
  4848. Parameters
  4849. stmtp (IN) - a statement (application request) handle.
  4850. errhp (IN) - an error handle which can be passed to OCIErrorGet() for
  4851. diagnostic information in the event of an error.
  4852. nrows (IN) - number of rows to be fetched from the current position.
  4853. It defaults to 1 for orientation OCI_FETCH_LAST.
  4854. orientation (IN) - The acceptable values are as follows, with
  4855. OCI_FETCH_NEXT being the default value.
  4856. OCI_FETCH_CURRENT gets the current row,
  4857. OCI_FETCH_NEXT gets the next row from the current position,
  4858. OCI_FETCH_FIRST gets the first row in the result set,
  4859. OCI_FETCH_LAST gets the last row in the result set,
  4860. OCI_FETCH_PRIOR gets the previous row from the current row in the result set,
  4861. OCI_FETCH_ABSOLUTE will fetch the row number (specified by fetchOffset
  4862. parameter) in the result set using absolute positioning,
  4863. OCI_FETCH_RELATIVE will fetch the row number (specified by fetchOffset
  4864. parameter) in the result set using relative positioning.
  4865. scrollOffset(IN) - offset used with the OCI_FETCH_ABSOLUTE and
  4866. OCI_FETCH_RELATIVE orientation parameters only. It specify
  4867. the new current position for scrollable result set. It is
  4868. ignored for non-scrollable result sets.
  4869. mode (IN) - for release 8.0, beta-1, the following mode is defined.
  4870. OCI_DEFAULT - default mode
  4871. OCI_EOF_FETCH - indicates that it is the last fetch from the result set.
  4872. If nrows is non-zero, setting this mode effectively cancels fetching after
  4873. retrieving nrows, otherwise it cancels fetching immediately.
  4874. Related Functions
  4875. OCIAttrGet()
  4876. OCIStmtGetPieceInfo()
  4877. Name
  4878. OCI Get Piece Information
  4879. Purpose
  4880. Returns piece information for a piecewise operation.
  4881. Syntax
  4882. sword OCIStmtGetPieceInfo( CONST OCIStmt *stmtp,
  4883. OCIError *errhp,
  4884. dvoid **hndlpp,
  4885. ub4 *typep,
  4886. ub1 *in_outp,
  4887. ub4 *iterp,
  4888. ub4 *idxp,
  4889. ub1 *piecep );
  4890. Comments
  4891. When an execute/fetch call returns OCI_NEED_DATA to get/return a
  4892. dynamic bind/define value or piece, OCIStmtGetPieceInfo() returns the
  4893. relevant information: bind/define handle, iteration or index number and
  4894. which piece.
  4895. See the section "Runtime Data Allocation and Piecewise Operations" on page
  4896. 5-16 for more information about using OCIStmtGetPieceInfo().
  4897. Parameters
  4898. stmtp (IN) - the statement when executed returned OCI_NEED_DATA.
  4899. errhp (OUT) - an error handle which can be passed to OCIErrorGet() for
  4900. diagnostic information in the event of an error.
  4901. hndlpp (OUT) - returns a pointer to the bind or define handle of the bind or
  4902. define whose runtime data is required or is being provided.
  4903. typep (OUT) - the type of the handle pointed to by hndlpp: OCI_HTYPE_BIND
  4904. (for a bind handle) or OCI_HTYPE_DEFINE (for a define handle).
  4905. in_outp (OUT) - returns OCI_PARAM_IN if the data is required for an IN bind
  4906. value. Returns OCI_PARAM_OUT if the data is available as an OUT bind
  4907. variable or a define position value.
  4908. iterp (OUT) - returns the row number of a multiple row operation.
  4909. idxp (OUT) - the index of an array element of a PL/SQL array bind operation.
  4910. piecep (OUT) - returns one of the following defined values -
  4911. OCI_ONE_PIECE, OCI_FIRST_PIECE, OCI_NEXT_PIECE and
  4912. OCI_LAST_PIECE. The default value is always OCI_ONE_PIECE.
  4913. Related Functions
  4914. OCIAttrGet(), OCIAttrGet(), OCIStmtExecute(), OCIStmtFetch(),
  4915. OCIStmtSetPieceInfo()
  4916. OCIStmtPrepare()
  4917. Name
  4918. OCI Statement REQuest
  4919. Purpose
  4920. This call defines the SQL/PLSQL statement to be executed.
  4921. Syntax
  4922. sword OCIStmtPrepare ( OCIStmt *stmtp,
  4923. OCIError *errhp,
  4924. CONST OraText *stmt,
  4925. ub4 stmt_len,
  4926. ub4 language,
  4927. ub4 mode);
  4928. Comments
  4929. This call is used to prepare a SQL or PL/SQL statement for execution. The
  4930. OCIStmtPrepare() call defines an application request.
  4931. This is a purely local call. Data values for this statement initialized in
  4932. subsequent bind calls will be stored in a bind handle which will hang off this
  4933. statement handle.
  4934. This call does not create an association between this statement handle and any
  4935. particular server.
  4936. See the section "Preparing Statements" on page 2-21 for more information
  4937. about using this call.
  4938. Parameters
  4939. stmtp (IN) - a statement handle.
  4940. errhp (IN) - an error handle to retrieve diagnostic information.
  4941. stmt (IN) - SQL or PL/SQL statement to be executed. Must be a null-terminated
  4942. string. The pointer to the OraText of the statement must be available as long
  4943. as the statement is executed.
  4944. stmt_len (IN) - length of the statement. Must not be zero.
  4945. language (IN) - V7, V8, or native syntax. Possible values are:
  4946. OCI_V7_SYNTAX - V7 ORACLE parsing syntax
  4947. OCI_V8_SYNTAX - V8 ORACLE parsing syntax
  4948. OCI_NTV_SYNTAX - syntax depending upon the version of the server.
  4949. mode (IN) - the only defined mode is OCI_DEFAULT for default mode.
  4950. Example
  4951. This example demonstrates the use of OCIStmtPrepare(), as well as the OCI
  4952. application initialization calls.
  4953. Related Functions
  4954. OCIAttrGet(), OCIStmtExecute()
  4955. OCIStmtPrepare2()
  4956. Name
  4957. OCI Statement REQuest with (a) early binding to svchp and/or
  4958. (b) stmt caching
  4959. Purpose
  4960. This call defines the SQL/PLSQL statement to be executed.
  4961. Syntax
  4962. sword OCIStmtPrepare2 ( OCISvcCtx *svchp,
  4963. OCIStmt **stmtp,
  4964. OCIError *errhp,
  4965. CONST OraText *stmt,
  4966. ub4 stmt_len,
  4967. CONST OraText *key,
  4968. ub4 key_len,
  4969. ub4 language,
  4970. ub4 mode);
  4971. Comments
  4972. This call is used to prepare a SQL or PL/SQL statement for execution. The
  4973. OCIStmtPrepare() call defines an application request.
  4974. This is a purely local call. Data values for this statement initialized in
  4975. subsequent bind calls will be stored in a bind handle which will hang off this
  4976. statement handle.
  4977. This call creates an association between the statement handle and a service
  4978. context. It differs from OCIStmtPrepare in that respect.It also supports
  4979. stmt caching. The stmt will automatically be cached if the authp of the stmt
  4980. has enabled stmt caching.
  4981. Parameters
  4982. svchp (IN) - the service context handle that contains the session that
  4983. this stmt handle belongs to.
  4984. stmtp (OUT) - an unallocated stmt handle must be pased in. An allocated
  4985. and prepared statement handle will be returned.
  4986. errhp (IN) - an error handle to retrieve diagnostic information.
  4987. stmt (IN) - SQL or PL/SQL statement to be executed. Must be a null-
  4988. terminated string. The pointer to the OraText of the statement
  4989. must be available as long as the statement is executed.
  4990. stmt_len (IN) - length of the statement. Must not be zero.
  4991. key (IN) - This is only Valid for OCI Stmt Caching. It indicates the
  4992. key to search with. It thus optimizes the search in the cache.
  4993. key_len (IN) - the length of the key. This, too, is onlly valid for stmt
  4994. caching.
  4995. language (IN) - V7, V8, or native syntax. Possible values are:
  4996. OCI_V7_SYNTAX - V7 ORACLE parsing syntax
  4997. OCI_V8_SYNTAX - V8 ORACLE parsing syntax
  4998. OCI_NTV_SYNTAX - syntax depending upon the version of the server.
  4999. mode (IN) - the defined modes are OCI_DEFAULT and OCI_PREP2_CACHE_SEARCHONLY.
  5000. Example
  5001. Related Functions
  5002. OCIStmtExecute(), OCIStmtRelease()
  5003. OCIStmtRelease()
  5004. Name
  5005. OCI Statement Release. This call is used to relesae the stmt that
  5006. was retreived using OCIStmtPrepare2(). If the stmt is release
  5007. using this call, OCIHandleFree() must not be called on the stmt
  5008. handle.
  5009. Purpose
  5010. This call releases the statement obtained by OCIStmtPrepare2
  5011. Syntax
  5012. sword OCIStmtRelease ( OCIStmt *stmtp,
  5013. OCIError *errhp,
  5014. cONST OraText *key,
  5015. ub4 key_len,
  5016. ub4 mode);
  5017. Comments
  5018. This call is used to release a handle obtained via OCIStmtPrepare2().
  5019. It also frees the memory associated with the handle.
  5020. This is a purely local call.
  5021. Parameters
  5022. stmtp (IN/OUT) - The statement handle to be released/freed.
  5023. errhp (IN) - an error handle to retrieve diagnostic information.
  5024. key (IN) - This is only Valid for OCI Stmt Caching. It indicates the
  5025. key to tag the stmt with.
  5026. key_len (IN) - the length of the key. This, too, is only valid for stmt
  5027. caching.
  5028. mode (IN) - the defined modes are OCI_DEFAULT for default mode and
  5029. OCI_STRLS_CACHE_DELETE (only used for Stmt Caching).
  5030. Example
  5031. Related Functions
  5032. OCIStmtExecute(), OCIStmtPrepare2()
  5033. OCIStmtSetPieceInfo()
  5034. Name
  5035. OCI Set Piece Information
  5036. Purpose
  5037. Sets piece information for a piecewise operation.
  5038. Syntax
  5039. sword OCIStmtSetPieceInfo ( dvoid *hndlp,
  5040. ub4 type,
  5041. OCIError *errhp,
  5042. CONST dvoid *bufp,
  5043. ub4 *alenp,
  5044. ub1 piece,
  5045. CONST dvoid *indp,
  5046. ub2 *rcodep );
  5047. Comments
  5048. When an execute call returns OCI_NEED_DATA to get a dynamic IN/OUT
  5049. bind value or piece, OCIStmtSetPieceInfo() sets the piece information: the
  5050. buffer, the length, the indicator and which piece is currently being processed.
  5051. For more information about using OCIStmtSetPieceInfo() see the section
  5052. "Runtime Data Allocation and Piecewise Operations" on page 5-16.
  5053. Parameters
  5054. hndlp (IN/OUT) - the bind/define handle.
  5055. type (IN) - type of the handle.
  5056. errhp (OUT) - an error handle which can be passed to OCIErrorGet() for
  5057. diagnostic information in the event of an error.
  5058. bufp (IN/OUT) - bufp is a pointer to a storage containing the data value or
  5059. the piece when it is an IN bind variable, otherwise bufp is a pointer to
  5060. storage for getting a piece or a value for OUT binds and define variables. For
  5061. named data types or REFs, a pointer to the object or REF is returned.
  5062. alenp (IN/OUT) - the length of the piece or the value.
  5063. piece (IN) - the piece parameter. The following are valid values:
  5064. OCI_ONE_PIECE, OCI_FIRST_PIECE, OCI_NEXT_PIECE, or
  5065. OCI_LAST_PIECE.
  5066. The default value is OCI_ONE_PIECE. This parameter is used for IN bind
  5067. variables only.
  5068. indp (IN/OUT) - indicator. A pointer to a sb2 value or pointer to an indicator
  5069. structure for named data types (SQLT_NTY) and REFs (SQLT_REF), i.e., *indp
  5070. is either an sb2 or a dvoid * depending upon the data type.
  5071. rcodep (IN/OUT) - return code.
  5072. Related Functions
  5073. OCIAttrGet(), OCIAttrGet(), OCIStmtExecute(), OCIStmtFetch(),
  5074. OCIStmtGetPieceInfo()
  5075. OCIFormatInit
  5076. Name
  5077. OCIFormat Package Initialize
  5078. Purpose
  5079. Initializes the OCIFormat package.
  5080. Syntax
  5081. sword OCIFormatInit(dvoid *hndl, OCIError *err);
  5082. Comments
  5083. This routine must be called before calling any other OCIFormat routine.
  5084. Returns OCI_SUCCESS, OCI_INVALID_HANDLE, or OCI_ERROR
  5085. Parameters
  5086. hndl (IN/OUT) - OCI environment or session handle
  5087. err (IN/OUT) - OCI error handle
  5088. Related Functions
  5089. OCIFormatTerm()
  5090. OCIFormatString
  5091. Name
  5092. OCIFormat Package Format String
  5093. Purpose
  5094. Writes a text string into the supplied text buffer using the argument
  5095. list submitted to it and in accordance with the format string given.
  5096. Syntax
  5097. sword OCIFormatString(dvoid *hndl, OCIError *err, OraText *buffer,
  5098. sbig_ora bufferLength, sbig_ora *returnLength,
  5099. CONST OraText *formatString, ...);
  5100. Comments
  5101. The first call to this routine must be preceded by a call to the
  5102. OCIFormatInit routine that initializes the OCIFormat package
  5103. for use. When this routine is no longer needed then terminate
  5104. the OCIFormat package by a call to the OCIFormatTerm routine.
  5105. Returns OCI_SUCCESS, OCI_INVALID_HANDLE, or OCI_ERROR
  5106. Parameters
  5107. hndl (IN/OUT) - OCI environment or session handle
  5108. err (IN/OUT) - OCI error handle
  5109. buffer (OUT) - text buffer for the string
  5110. bufferLength (IN) - length of the text buffer
  5111. returnLength (OUT) - length of the formatted string
  5112. formatString (IN) - format specification string
  5113. ... (IN) - variable argument list
  5114. Related Functions
  5115. OCIFormatTerm
  5116. Name
  5117. OCIFormat Package Terminate
  5118. Purpose
  5119. Terminates the OCIFormat package.
  5120. Syntax
  5121. sword OCIFormatTerm(dvoid *hndl, OCIError *err);
  5122. Comments
  5123. It must be called after the OCIFormat package is no longer being used.
  5124. Returns OCI_SUCCESS, OCI_INVALID_HANDLE, or OCI_ERROR
  5125. Parameters
  5126. hndl (IN/OUT) - OCI environment or session handle
  5127. err (IN/OUT) - OCI error handle
  5128. Related Functions
  5129. OCIFormatInit()
  5130. OCIFormatTUb1
  5131. Name
  5132. OCIFormat Package ub1 Type
  5133. Purpose
  5134. Return the type value for the ub1 type.
  5135. Syntax
  5136. sword OCIFormatTUb1(void);
  5137. Comments
  5138. None
  5139. Parameters
  5140. None
  5141. Related Functions
  5142. None
  5143. OCIFormatTUb2
  5144. Name
  5145. OCIFormat Package ub2 Type
  5146. Purpose
  5147. Return the type value for the ub2 type.
  5148. Syntax
  5149. sword OCIFormatTUb2(void);
  5150. Comments
  5151. None
  5152. Parameters
  5153. None
  5154. Related Functions
  5155. None
  5156. OCIFormatTUb4
  5157. Name
  5158. OCIFormat Package ub4 Type
  5159. Purpose
  5160. Return the type value for the ub4 type.
  5161. Syntax
  5162. sword OCIFormatTUb4(void);
  5163. Comments
  5164. None
  5165. Parameters
  5166. None
  5167. Related Functions
  5168. None
  5169. OCIFormatTUword
  5170. Name
  5171. OCIFormat Package uword Type
  5172. Purpose
  5173. Return the type value for the uword type.
  5174. Syntax
  5175. sword OCIFormatTUword(void);
  5176. Comments
  5177. None
  5178. Parameters
  5179. None
  5180. Related Functions
  5181. None
  5182. OCIFormatTUbig_ora
  5183. Name
  5184. OCIFormat Package ubig_ora Type
  5185. Purpose
  5186. Return the type value for the ubig_ora type.
  5187. Syntax
  5188. sword OCIFormatTUbig_ora(void);
  5189. Comments
  5190. None
  5191. Parameters
  5192. None
  5193. Related Functions
  5194. None
  5195. OCIFormatTSb1
  5196. Name
  5197. OCIFormat Package sb1 Type
  5198. Purpose
  5199. Return the type value for the sb1 type.
  5200. Syntax
  5201. sword OCIFormatTSb1(void);
  5202. Comments
  5203. None
  5204. Parameters
  5205. None
  5206. Related Functions
  5207. None
  5208. OCIFormatTSb2
  5209. Name
  5210. OCIFormat Package sb2 Type
  5211. Purpose
  5212. Return the type value for the sb2 type.
  5213. Syntax
  5214. sword OCIFormatTSb2(void);
  5215. Comments
  5216. None
  5217. Parameters
  5218. None
  5219. Related Functions
  5220. None
  5221. OCIFormatTSb4
  5222. Name
  5223. OCIFormat Package sb4 Type
  5224. Purpose
  5225. Return the type value for the sb4 type.
  5226. Syntax
  5227. sword OCIFormatTSb4(void);
  5228. Comments
  5229. None
  5230. Parameters
  5231. None
  5232. Related Functions
  5233. None
  5234. OCIFormatTSword
  5235. Name
  5236. OCIFormat Package sword Type
  5237. Purpose
  5238. Return the type value for the sword type.
  5239. Syntax
  5240. sword OCIFormatTSword(void);
  5241. Comments
  5242. None
  5243. Parameters
  5244. None
  5245. Related Functions
  5246. None
  5247. OCIFormatTSbig_ora
  5248. Name
  5249. OCIFormat Package sbig_ora Type
  5250. Purpose
  5251. Return the type value for the sbig_ora type.
  5252. Syntax
  5253. sword OCIFormatTSbig_ora(void);
  5254. Comments
  5255. None
  5256. Parameters
  5257. None
  5258. Related Functions
  5259. None
  5260. OCIFormatTEb1
  5261. Name
  5262. OCIFormat Package eb1 Type
  5263. Purpose
  5264. Return the type value for the eb1 type.
  5265. Syntax
  5266. sword OCIFormatTEb1(void);
  5267. Comments
  5268. None
  5269. Parameters
  5270. None
  5271. Related Functions
  5272. None
  5273. OCIFormatTEb2
  5274. Name
  5275. OCIFormat Package eb2 Type
  5276. Purpose
  5277. Return the type value for the eb2 type.
  5278. Syntax
  5279. sword OCIFormatTEb2(void);
  5280. Comments
  5281. None
  5282. Parameters
  5283. None
  5284. Related Functions
  5285. None
  5286. OCIFormatTEb4
  5287. Name
  5288. OCIFormat Package eb4 Type
  5289. Purpose
  5290. Return the type value for the eb4 type.
  5291. Syntax
  5292. sword OCIFormatTEb4(void);
  5293. Comments
  5294. None
  5295. Parameters
  5296. None
  5297. Related Functions
  5298. None
  5299. OCIFormatTEword
  5300. Name
  5301. OCIFormat Package eword Type
  5302. Purpose
  5303. Return the type value for the eword type.
  5304. Syntax
  5305. sword OCIFormatTEword(void);
  5306. Comments
  5307. None
  5308. Parameters
  5309. None
  5310. Related Functions
  5311. None
  5312. OCIFormatTChar
  5313. Name
  5314. OCIFormat Package text Type
  5315. Purpose
  5316. Return the type value for the text type.
  5317. Syntax
  5318. sword OCIFormatTChar(void);
  5319. Comments
  5320. None
  5321. Parameters
  5322. None
  5323. Related Functions
  5324. None
  5325. OCIFormatTText
  5326. Name
  5327. OCIFormat Package *text Type
  5328. Purpose
  5329. Return the type value for the *text type.
  5330. Syntax
  5331. sword OCIFormatTText(void);
  5332. Comments
  5333. None
  5334. Parameters
  5335. None
  5336. Related Functions
  5337. None
  5338. OCIFormatTDouble
  5339. Name
  5340. OCIFormat Package double Type
  5341. Purpose
  5342. Return the type value for the double type.
  5343. Syntax
  5344. sword OCIFormatTDouble(void);
  5345. Comments
  5346. None
  5347. Parameters
  5348. None
  5349. Related Functions
  5350. None
  5351. OCIFormatDvoid
  5352. Name
  5353. OCIFormat Package dvoid Type
  5354. Purpose
  5355. Return the type value for the dvoid type.
  5356. Syntax
  5357. sword OCIFormatTDvoid(void);
  5358. Comments
  5359. None
  5360. Parameters
  5361. None
  5362. Related Functions
  5363. None
  5364. OCIFormatTEnd
  5365. Name
  5366. OCIFormat Package end Type
  5367. Purpose
  5368. Return the list terminator's "type".
  5369. Syntax
  5370. sword OCIFormatTEnd(void);
  5371. Comments
  5372. None
  5373. Parameters
  5374. None
  5375. Related Functions
  5376. None
  5377. OCISvcCtxToLda()
  5378. Name
  5379. OCI toggle SerVice context handle to Version 7 Lda_Def
  5380. Purpose
  5381. Toggles between a V8 service context handle and a V7 Lda_Def.
  5382. Syntax
  5383. sword OCISvcCtxToLda ( OCISvcCtx *srvhp,
  5384. OCIError *errhp,
  5385. Lda_Def *ldap );
  5386. Comments
  5387. Toggles between an Oracle8 service context handle and an Oracle7 Lda_Def.
  5388. This function can only be called after a service context has been properly
  5389. initialized.
  5390. Once the service context has been translated to an Lda_Def, it can be used in
  5391. release 7.x OCI calls (e.g., obindps(), ofen()).
  5392. Note: If there are multiple service contexts which share the same server
  5393. handle, only one can be in V7 mode at any time.
  5394. The action of this call can be reversed by passing the resulting Lda_Def to
  5395. the OCILdaToSvcCtx() function.
  5396. Parameters
  5397. svchp (IN/OUT) - the service context handle.
  5398. errhp (IN/OUT) - an error handle which can be passed to OCIErrorGet() for
  5399. diagnostic information in the event of an error.
  5400. ldap (IN/OUT) - a Logon Data Area for V7-style OCI calls which is initialized
  5401. by this call.
  5402. Related Functions
  5403. OCILdaToSvcCtx()
  5404. OCITransCommit()
  5405. Name
  5406. OCI TX (transaction) CoMmit
  5407. Purpose
  5408. Commits the transaction associated with a specified service context.
  5409. Syntax
  5410. sword OCITransCommit ( OCISvcCtx *srvcp,
  5411. OCIError *errhp,
  5412. ub4 flags );
  5413. Comments
  5414. The transaction currently associated with the service context is committed. If
  5415. it is a distributed transaction that the server cannot commit, this call
  5416. additionally retrieves the state of the transaction from the database to be
  5417. returned to the user in the error handle.
  5418. If the application has defined multiple transactions, this function operates
  5419. on the transaction currently associated with the service context. If the
  5420. application is working with only the implicit local transaction created when
  5421. database changes are made, that implicit transaction is committed.
  5422. If the application is running in the object mode, then the modified or updated
  5423. objects in the object cache for this transaction are also committed.
  5424. The flags parameter is used for one-phase commit optimization in distributed
  5425. transactions. If the transaction is non-distributed, the flags parameter is
  5426. ignored, and OCI_DEFAULT can be passed as its value. OCI applications
  5427. managing global transactions should pass a value of
  5428. OCI_TRANS_TWOPHASE to the flags parameter for a two-phase commit. The
  5429. default is one-phase commit.
  5430. Under normal circumstances, OCITransCommit() returns with a status
  5431. indicating that the transaction has either been committed or rolled back. With
  5432. distributed transactions, it is possible that the transaction is now in-doubt
  5433. (i.e., neither committed nor aborted). In this case, OCITransCommit()
  5434. attempts to retrieve the status of the transaction from the server.
  5435. The status is returned.
  5436. Parameters
  5437. srvcp (IN) - the service context handle.
  5438. errhp (IN) - an error handle which can be passed to OCIErrorGet() for
  5439. diagnostic information in the event of an error.
  5440. flags -see the "Comments" section above.
  5441. Related Functions
  5442. OCITransRollback()
  5443. OCITransDetach()
  5444. Name
  5445. OCI TX (transaction) DeTach
  5446. Purpose
  5447. Detaches a transaction.
  5448. Syntax
  5449. sword OCITransDetach ( OCISvcCtx *srvcp,
  5450. OCIError *errhp,
  5451. ub4 flags);
  5452. Comments
  5453. Detaches a global transaction from the service context handle. The transaction
  5454. currently attached to the service context handle becomes inactive at the end
  5455. of this call. The transaction may be resumed later by calling OCITransStart(),
  5456. specifying a flags value of OCI_TRANS_RESUME.
  5457. When a transaction is detached, the value which was specified in the timeout
  5458. parameter of OCITransStart() when the transaction was started is used to
  5459. determine the amount of time the branch can remain inactive before being
  5460. deleted by the server's PMON process.
  5461. Note: The transaction can be resumed by a different process than the one
  5462. that detached it, provided that the transaction has the same
  5463. authorization.
  5464. Parameters
  5465. srvcp (IN) - the service context handle.
  5466. errhp (IN) - an error handle which can be passed to OCIErrorGet() for
  5467. diagnostic information in the event of an error.
  5468. flags (IN) - you must pass a value of OCI_DEFAULT for this parameter.
  5469. Related Functions
  5470. OCITransStart()
  5471. OCITransForget()
  5472. Name
  5473. OCI TX (transaction) ForGeT
  5474. Purpose
  5475. Causes the server to forget a heuristically completed global transaction.
  5476. Syntax
  5477. sword OCITransForget ( OCISvcCtx *svchp,
  5478. OCIError *errhp,
  5479. ub4 flags);
  5480. Comments
  5481. Forgets a heuristically completed global transaction. The server deletes the
  5482. status of the transaction from the system's pending transaction table.
  5483. The XID of the transaction to be forgotten is set as an attribute of the
  5484. transaction handle (OCI_ATTR_XID).
  5485. Parameters
  5486. srvcp (IN) - the service context handle - the transaction is rolled back.
  5487. errhp (IN) - an error handle which can be passed to OCIErrorGet() for
  5488. diagnostic information in the event of an error.
  5489. flags (IN) - you must pass OCI_DEFAULT for this parameter.
  5490. Related Functions
  5491. OCITransCommit(), OCITransRollback()
  5492. OCITransMultiPrepare()
  5493. Name
  5494. OCI Trans(action) Multi-Branch Prepare
  5495. Purpose
  5496. Prepares a transaction with multiple branches in a single call.
  5497. Syntax
  5498. sword OCITransMultiPrepare ( OCISvcCtx *svchp,
  5499. ub4 numBranches,
  5500. OCITrans **txns,
  5501. OCIError **errhp);
  5502. Comments
  5503. Prepares the specified global transaction for commit.
  5504. This call is valid only for distributed transactions.
  5505. This call is an advanced performance feature intended for use only in
  5506. situations where the caller is responsible for preparing all the branches
  5507. in a transaction.
  5508. Parameters
  5509. srvcp (IN) - the service context handle.
  5510. numBranches (IN) - This is the number of branches expected. It is also the
  5511. array size for the next two parameters.
  5512. txns (IN) - This is the array of transaction handles for the branches to
  5513. prepare. They should all have the OCI_ATTR_XID set. The global transaction
  5514. ID should be the same.
  5515. errhp (IN) - This is the array of error handles. If OCI_SUCCESS is not
  5516. returned, then these will indicate which branches received which errors.
  5517. Related Functions
  5518. OCITransPrepare()
  5519. OCITransPrepare()
  5520. Name
  5521. OCI TX (transaction) PREpare
  5522. Purpose
  5523. Prepares a transaction for commit.
  5524. Syntax
  5525. sword OCITransPrepare ( OCISvcCtx *svchp,
  5526. OCIError *errhp,
  5527. ub4 flags);
  5528. Comments
  5529. Prepares the specified global transaction for commit.
  5530. This call is valid only for distributed transactions.
  5531. The call returns OCI_SUCCESS_WITH_INFO if the transaction has not made
  5532. any changes. The error handle will indicate that the transaction is read-only.
  5533. The flag parameter is not currently used.
  5534. Parameters
  5535. srvcp (IN) - the service context handle.
  5536. errhp (IN) - an error handle which can be passed to OCIErrorGet() for
  5537. diagnostic information in the event of an error.
  5538. flags (IN) - you must pass OCI_DEFAULT for this parameter.
  5539. Related Functions
  5540. OCITransCommit(), OCITransForget()
  5541. OCITransRollback()
  5542. Name
  5543. OCI TX (transaction) RoLlback
  5544. Purpose
  5545. Rolls back the current transaction.
  5546. Syntax
  5547. sword OCITransRollback ( dvoid *svchp,
  5548. OCIError *errhp,
  5549. ub4 flags );
  5550. Comments
  5551. The current transaction- defined as the set of statements executed since the
  5552. last OCITransCommit() or since OCISessionBegin()-is rolled back.
  5553. If the application is running under object mode then the modified or updated
  5554. objects in the object cache for this transaction are also rolled back.
  5555. An error is returned if an attempt is made to roll back a global transaction
  5556. that is not currently active.
  5557. Parameters
  5558. svchp (IN) - a service context handle. The transaction currently set in the
  5559. service context handle is rolled back.
  5560. errhp -(IN) - an error handle which can be passed to OCIErrorGet() for
  5561. diagnostic information in the event of an error.
  5562. flags - you must pass a value of OCI_DEFAULT for this parameter.
  5563. Related Functions
  5564. OCITransCommit()
  5565. OCITransStart()
  5566. Name
  5567. OCI TX (transaction) STart
  5568. Purpose
  5569. Sets the beginning of a transaction.
  5570. Syntax
  5571. sword OCITransStart ( OCISvcCtx *svchp,
  5572. OCIError *errhp,
  5573. uword timeout,
  5574. ub4 flags);
  5575. Comments
  5576. This function sets the beginning of a global or serializable transaction. The
  5577. transaction context currently associated with the service context handle is
  5578. initialized at the end of the call if the flags parameter specifies that a new
  5579. transaction should be started.
  5580. The XID of the transaction is set as an attribute of the transaction handle
  5581. (OCI_ATTR_XID)
  5582. Parameters
  5583. svchp (IN/OUT) - the service context handle. The transaction context in the
  5584. service context handle is initialized at the end of the call if the flag
  5585. specified a new transaction to be started.
  5586. errhp (IN/OUT) - The OCI error handle. If there is an error, it is recorded in
  5587. err and this function returns OCI_ERROR. Diagnostic information can be
  5588. obtained by calling OCIErrorGet().
  5589. timeout (IN) - the time, in seconds, to wait for a transaction to become
  5590. available for resumption when OCI_TRANS_RESUME is specified. When
  5591. OCI_TRANS_NEW is specified, this value is stored and may be used later by
  5592. OCITransDetach().
  5593. flags (IN) - specifies whether a new transaction is being started or an
  5594. existing transaction is being resumed. Also specifies serializiability or
  5595. read-only status. More than a single value can be specified. By default,
  5596. a read/write transaction is started. The flag values are:
  5597. OCI_TRANS_NEW - starts a new transaction branch. By default starts a
  5598. tightly coupled and migratable branch.
  5599. OCI_TRANS_TIGHT - explicitly specifies a tightly coupled branch
  5600. OCI_TRANS_LOOSE - specifies a loosely coupled branch
  5601. OCI_TRANS_RESUME - resumes an existing transaction branch.
  5602. OCI_TRANS_READONLY - start a readonly transaction
  5603. OCI_TRANS_SERIALIZABLE - start a serializable transaction
  5604. Related Functions
  5605. OCITransDetach()
  5606. ***************************************************************************** }
  5607. {-----------------------Dynamic Callback Function Pointers------------------ }
  5608. type
  5609. OCICallbackInBind = function (ictxp:Pdvoid; bindp:POCIBind; iter:ub4; index:ub4; bufpp:PPdvoid;
  5610. alenp:Pub4; piecep:Pub1; indp:PPdvoid):sb4;cdecl;
  5611. OCICallbackOutBind = function (octxp:Pdvoid; bindp:POCIBind; iter:ub4; index:ub4; bufpp:PPdvoid;
  5612. alenp:PPub4; piecep:Pub1; indp:PPdvoid; rcodep:PPub2):sb4;cdecl;
  5613. OCICallbackDefine = function (octxp:Pdvoid; defnp:POCIDefine; iter:ub4; bufpp:PPdvoid; alenp:PPub4;
  5614. piecep:Pub1; indp:PPdvoid; rcodep:PPub2):sb4;cdecl;
  5615. // OCIUserCallback = function (ctxp:Pdvoid; hndlp:Pdvoid; _type:ub4; fcode:ub4; when:ub4;
  5616. // returnCode:sword; errnop:Psb4; arglist:va_list):sword;cdecl;
  5617. OCIEnvCallbackType = function (env:POCIEnv; mode:ub4; xtramem_sz:size_t; usrmemp:Pdvoid; ucbDesc:POCIUcb):sword;cdecl;
  5618. (* Const before type ignored *)
  5619. OCICallbackLobRead = function (ctxp:Pdvoid; bufp:Pdvoid; len:ub4; piece:ub1):sb4;cdecl;
  5620. OCICallbackLobWrite = function (ctxp:Pdvoid; bufp:Pdvoid; lenp:Pub4; piece:Pub1):sb4;cdecl;
  5621. {$ifdef ORAXB8_DEFINED}
  5622. (* Const before type ignored *)
  5623. type
  5624. OCICallbackLobRead2 = function (ctxp:Pdvoid; bufp:Pdvoid; len:oraub8; piece:ub1; changed_bufpp:PPdvoid;
  5625. changed_lenp:Poraub8):sb4;cdecl;
  5626. OCICallbackLobWrite2 = function (ctxp:Pdvoid; bufp:Pdvoid; lenp:Poraub8; piece:Pub1; changed_bufpp:PPdvoid;
  5627. changed_lenp:Poraub8):sb4;cdecl;
  5628. (* Const before type ignored *)
  5629. OCICallbackLobArrayRead = function (ctxp:Pdvoid; array_iter:ub4; bufp:Pdvoid; len:oraub8; piece:ub1;
  5630. changed_bufpp:PPdvoid; changed_lenp:Poraub8):sb4;cdecl;
  5631. OCICallbackLobArrayWrite = function (ctxp:Pdvoid; array_iter:ub4; bufp:Pdvoid; lenp:Poraub8; piece:Pub1;
  5632. changed_bufpp:PPdvoid; changed_lenp:Poraub8):sb4;cdecl;
  5633. {$endif}
  5634. type
  5635. OCICallbackAQEnq = function (ctxp:Pdvoid; payload:PPdvoid; payload_ind:PPdvoid):sb4;cdecl;
  5636. OCICallbackAQDeq = function (ctxp:Pdvoid; payload:PPdvoid; payload_ind:PPdvoid):sb4;cdecl;
  5637. {--------------------------Failover Callback Structure --------------------- }
  5638. OCICallbackFailover = function (svcctx:Pdvoid; envctx:Pdvoid; fo_ctx:Pdvoid; fo_type:ub4; fo_event:ub4):sb4;cdecl;
  5639. POCIFocbkStruct = ^OCIFocbkStruct;
  5640. OCIFocbkStruct = record
  5641. callback_function : OCICallbackFailover;
  5642. fo_ctx : Pdvoid;
  5643. end;
  5644. {--------------------------HA Callback Structure --------------------- }
  5645. OCIEventCallback = procedure (evtctx:Pdvoid; eventhp:POCIEvent);cdecl;
  5646. {****************************************************************************
  5647. ACTUAL PROTOTYPE DECLARATIONS
  5648. ***************************************************************************** }
  5649. type
  5650. tmalocfp = function (ctxp:Pdvoid; size:size_t):Pdvoid;
  5651. tralocfp = function (ctxp:Pdvoid; memptr:Pdvoid;newsize:size_t):Pdvoid;
  5652. tmfreefp = procedure (ctxp:Pdvoid; memptr:Pdvoid);
  5653. {$IFNDEF LinkDynamically}
  5654. function OCIInitialize(mode:ub4; ctxp:Pdvoid; malocfp:tmalocfp; ralocfp:tralocfp;mfreefp:tmfreefp ):sword;cdecl;external ocilib name 'OCIInitialize';
  5655. function OCITerminate(mode:ub4):sword;cdecl;external ocilib name 'OCITerminate';
  5656. function OCIEnvCreate(var envp:POCIEnv; mode:ub4; ctxp:Pdvoid; malocfp:tmalocfp; ralocfp:tralocfp;
  5657. mfreefp:tmfreefp; xtramem_sz:size_t; usrmempp:PPdvoid):sword;cdecl;external ocilib name 'OCIEnvCreate';
  5658. function OCIEnvNlsCreate(var envp:POCIEnv; mode:ub4; ctxp:Pdvoid; malocfp:tmalocfp; ralocfp:tralocfp;
  5659. mfreefp:tmfreefp; xtramem_sz:size_t; usrmempp:PPdvoid; charset:ub2; ncharset:ub2):sword;cdecl;external ocilib name 'OCIEnvNlsCreate';
  5660. function OCIFEnvCreate(var envp:POCIEnv; mode:ub4; ctxp:Pdvoid; malocfp:tmalocfp; ralocfp:tralocfp;
  5661. mfreefp:tmfreefp; xtramem_sz:size_t; usrmempp:PPdvoid; fupg:Pdvoid):sword;cdecl;external ocilib name 'OCIFEnvCreate';
  5662. function OCIHandleAlloc(parenth:Pdvoid; var hndlpp:Pdvoid; _type:ub4; xtramem_sz:size_t; usrmempp:PPdvoid):sword;cdecl;external ocilib name 'OCIHandleAlloc';
  5663. function OCIHandleFree(hndlp:Pdvoid; _type:ub4):sword;cdecl;external ocilib name 'OCIHandleFree';
  5664. function OCIDescriptorAlloc(parenth:Pdvoid; descpp:PPdvoid; _type:ub4; xtramem_sz:size_t; usrmempp:PPdvoid):sword;cdecl;external ocilib name 'OCIDescriptorAlloc';
  5665. function OCIDescriptorFree(descp:Pdvoid; _type:ub4):sword;cdecl;external ocilib name 'OCIDescriptorFree';
  5666. function OCIEnvInit(var envp:POCIEnv; mode:ub4; xtramem_sz:size_t; usrmempp:PPdvoid):sword;cdecl;external ocilib name 'OCIEnvInit';
  5667. function OCIServerAttach(srvhp:POCIServer; errhp:POCIError; dblink:POraText; dblink_len:sb4; mode:ub4):sword;cdecl;external ocilib name 'OCIServerAttach';
  5668. function OCIServerDetach(srvhp:POCIServer; errhp:POCIError; mode:ub4):sword;cdecl;external ocilib name 'OCIServerDetach';
  5669. function OCISessionBegin(svchp:POCISvcCtx; errhp:POCIError; usrhp:POCISession; credt:ub4; mode:ub4):sword;cdecl;external ocilib name 'OCISessionBegin';
  5670. function OCISessionEnd(svchp:POCISvcCtx; errhp:POCIError; usrhp:POCISession; mode:ub4):sword;cdecl;external ocilib name 'OCISessionEnd';
  5671. function OCILogon(envhp:POCIEnv; errhp:POCIError;var svchp:POCISvcCtx; username:POraText; uname_len:ub4;
  5672. password:POraText; passwd_len:ub4; dbname:POraText; dbname_len:ub4):sword;cdecl;external ocilib name 'OCILogon';
  5673. function OCILogon2(envhp:POCIEnv; errhp:POCIError; var svchp:POCISvcCtx; username:POraText; uname_len:ub4;
  5674. password:POraText; passwd_len:ub4; dbname:POraText; dbname_len:ub4; mode:ub4):sword;cdecl;external ocilib name 'OCILogon2';
  5675. function OCILogoff(svchp:POCISvcCtx; errhp:POCIError):sword;cdecl;external ocilib name 'OCILogoff';
  5676. function OCIPasswordChange(svchp:POCISvcCtx; errhp:POCIError; user_name:POraText; usernm_len:ub4; opasswd:POraText;
  5677. opasswd_len:ub4; npasswd:POraText; npasswd_len:ub4; mode:ub4):sword;cdecl;external ocilib name 'OCIPasswordChange';
  5678. function OCIStmtPrepare(stmtp:POCIStmt; errhp:POCIError; stmt:POraText; stmt_len:ub4; language:ub4;
  5679. mode:ub4):sword;cdecl;external ocilib name 'OCIStmtPrepare';
  5680. function OCIStmtPrepare2(svchp:POCISvcCtx; var stmtp:POCIStmt; errhp:POCIError; stmt:POraText; stmt_len:ub4;
  5681. key:POraText; key_len:ub4; language:ub4; mode:ub4):sword;cdecl;external ocilib name 'OCIStmtPrepare2';
  5682. function OCIStmtRelease(stmtp:POCIStmt; errhp:POCIError; key:POraText; key_len:ub4; mode:ub4):sword;cdecl;external ocilib name 'OCIStmtRelease';
  5683. function OCIBindByPos(stmtp:POCIStmt; var bindp:POCIBind; errhp:POCIError; position:ub4; valuep:Pdvoid;
  5684. value_sz:sb4; dty:ub2; indp:Pdvoid; alenp:Pub2; rcodep:Pub2;
  5685. maxarr_len:ub4; curelep:Pub4; mode:ub4):sword;cdecl;external ocilib name 'OCIBindByPos';
  5686. function OCIBindByName(stmtp:POCIStmt; var bindp: POCIBind; errhp:POCIError; placeholder:POraText; placeh_len:sb4;
  5687. valuep:Pdvoid; value_sz:sb4; dty:ub2; indp:Pdvoid; alenp:Pub2;
  5688. rcodep:Pub2; maxarr_len:ub4; curelep:Pub4; mode:ub4):sword;cdecl;external ocilib name 'OCIBindByName';
  5689. function OCIBindObject(bindp:POCIBind; errhp:POCIError; _type:POCIType; pgvpp:PPdvoid; pvszsp:Pub4;
  5690. indpp:PPdvoid; indszp:Pub4):sword;cdecl;external ocilib name 'OCIBindObject';
  5691. function OCIBindDynamic(bindp:POCIBind; errhp:POCIError; ictxp:Pdvoid; icbfp:OCICallbackInBind; octxp:Pdvoid;
  5692. ocbfp:OCICallbackOutBind):sword;cdecl;external ocilib name 'OCIBindDynamic';
  5693. function OCIBindArrayOfStruct(bindp:POCIBind; errhp:POCIError; pvskip:ub4; indskip:ub4; alskip:ub4;
  5694. rcskip:ub4):sword;cdecl;external ocilib name 'OCIBindArrayOfStruct';
  5695. function OCIStmtGetPieceInfo(stmtp:POCIStmt; errhp:POCIError; hndlpp:PPdvoid; typep:Pub4; in_outp:Pub1;
  5696. iterp:Pub4; idxp:Pub4; piecep:Pub1):sword;cdecl;external ocilib name 'OCIStmtGetPieceInfo';
  5697. function OCIStmtSetPieceInfo(hndlp:Pdvoid; _type:ub4; errhp:POCIError; bufp:Pdvoid; alenp:Pub4;
  5698. piece:ub1; indp:Pdvoid; rcodep:Pub2):sword;cdecl;external ocilib name 'OCIStmtSetPieceInfo';
  5699. function OCIStmtExecute(svchp:POCISvcCtx; stmtp:POCIStmt; errhp:POCIError; iters:ub4; rowoff:ub4;
  5700. snap_in:POCISnapshot; snap_out:POCISnapshot; mode:ub4):sword;cdecl;external ocilib name 'OCIStmtExecute';
  5701. function OCIDefineByPos(stmtp:POCIStmt; var defnp:POCIDefine; errhp:POCIError; position:ub4; valuep:Pdvoid;
  5702. value_sz:sb4; dty:ub2; indp:Pdvoid; rlenp:Pub2; rcodep:Pub2;
  5703. mode:ub4):sword;cdecl;external ocilib name 'OCIDefineByPos';
  5704. function OCIDefineObject(defnp:POCIDefine; errhp:POCIError; _type:POCIType; pgvpp:PPdvoid; pvszsp:Pub4;
  5705. indpp:PPdvoid; indszp:Pub4):sword;cdecl;external ocilib name 'OCIDefineObject';
  5706. function OCIDefineDynamic(defnp:POCIDefine; errhp:POCIError; octxp:Pdvoid; ocbfp:OCICallbackDefine):sword;cdecl;external ocilib name 'OCIDefineDynamic';
  5707. function OCIRowidToChar(rowidDesc:POCIRowid; outbfp:POraText; outbflp:Pub2; errhp:POCIError):sword;cdecl;external ocilib name 'OCIRowidToChar';
  5708. function OCIDefineArrayOfStruct(defnp:POCIDefine; errhp:POCIError; pvskip:ub4; indskip:ub4; rlskip:ub4;
  5709. rcskip:ub4):sword;cdecl;external ocilib name 'OCIDefineArrayOfStruct';
  5710. function OCIStmtFetch(stmtp:POCIStmt; errhp:POCIError; nrows:ub4; orientation:ub2; mode:ub4):sword;cdecl;external ocilib name 'OCIStmtFetch';
  5711. function OCIStmtFetch2(stmtp:POCIStmt; errhp:POCIError; nrows:ub4; orientation:ub2; scrollOffset:sb4;
  5712. mode:ub4):sword;cdecl;external ocilib name 'OCIStmtFetch2';
  5713. function OCIStmtGetBindInfo(stmtp:POCIStmt; errhp:POCIError; size:ub4; startloc:ub4; found:Psb4;
  5714. bvnp:array of POraText; bvnl:array of ub1; invp:array of POraText; inpl:array of ub1; dupl:array of ub1;
  5715. var hndl:POCIBind):sword;cdecl;external ocilib name 'OCIStmtGetBindInfo';
  5716. function OCIDescribeAny(svchp:POCISvcCtx; errhp:POCIError; objptr:Pdvoid; objnm_len:ub4; objptr_typ:ub1;
  5717. info_level:ub1; objtyp:ub1; dschp:POCIDescribe):sword;cdecl;external ocilib name 'OCIDescribeAny';
  5718. function OCIParamGet(hndlp:Pdvoid; htype:ub4; errhp:POCIError; var parmdpp:Pdvoid; pos:ub4):sword;cdecl;external ocilib name 'OCIParamGet';
  5719. function OCIParamSet(hdlp:Pdvoid; htyp:ub4; errhp:POCIError; dscp:Pdvoid; dtyp:ub4;
  5720. pos:ub4):sword;cdecl;external ocilib name 'OCIParamSet';
  5721. function OCITransStart(svchp:POCISvcCtx; errhp:POCIError; timeout:uword; flags:ub4):sword;cdecl;external ocilib name 'OCITransStart';
  5722. function OCITransDetach(svchp:POCISvcCtx; errhp:POCIError; flags:ub4):sword;cdecl;external ocilib name 'OCITransDetach';
  5723. function OCITransCommit(svchp:POCISvcCtx; errhp:POCIError; flags:ub4):sword;cdecl;external ocilib name 'OCITransCommit';
  5724. function OCITransRollback(svchp:POCISvcCtx; errhp:POCIError; flags:ub4):sword;cdecl;external ocilib name 'OCITransRollback';
  5725. function OCITransPrepare(svchp:POCISvcCtx; errhp:POCIError; flags:ub4):sword;cdecl;external ocilib name 'OCITransPrepare';
  5726. function OCITransMultiPrepare(svchp:POCISvcCtx; numBranches:ub4; var txns:POCITrans; var errhp:POCIError):sword;cdecl;external ocilib name 'OCITransMultiPrepare';
  5727. function OCITransForget(svchp:POCISvcCtx; errhp:POCIError; flags:ub4):sword;cdecl;external ocilib name 'OCITransForget';
  5728. function OCIErrorGet(hndlp:Pdvoid; recordno:ub4; sqlstate:POraText; var errcodep:sb4; bufp:POraText;
  5729. bufsiz:ub4; _type:ub4):sword;cdecl;external ocilib name 'OCIErrorGet';
  5730. function OCILobAppend(svchp:POCISvcCtx; errhp:POCIError; dst_locp:POCILobLocator; src_locp:POCILobLocator):sword;cdecl;external ocilib name 'OCILobAppend';
  5731. function OCILobAssign(envhp:POCIEnv; errhp:POCIError; src_locp:POCILobLocator; var dst_locpp:POCILobLocator):sword;cdecl;external ocilib name 'OCILobAssign';
  5732. function OCILobCharSetForm(envhp:POCIEnv; errhp:POCIError; locp:POCILobLocator; csfrm:Pub1):sword;cdecl;external ocilib name 'OCILobCharSetForm';
  5733. function OCILobCharSetId(envhp:POCIEnv; errhp:POCIError; locp:POCILobLocator; csid:Pub2):sword;cdecl;external ocilib name 'OCILobCharSetId';
  5734. function OCILobCopy(svchp:POCISvcCtx; errhp:POCIError; dst_locp:POCILobLocator; src_locp:POCILobLocator; amount:ub4;
  5735. dst_offset:ub4; src_offset:ub4):sword;cdecl;external ocilib name 'OCILobCopy';
  5736. function OCILobCreateTemporary(svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; csid:ub2; csfrm:ub1;
  5737. lobtype:ub1; cache:boolean; duration:OCIDuration):sword;cdecl;external ocilib name 'OCILobCreateTemporary';
  5738. function OCILobClose(svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator):sword;cdecl;external ocilib name 'OCILobClose';
  5739. function OCILobDisableBuffering(svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator):sword;cdecl;external ocilib name 'OCILobDisableBuffering';
  5740. function OCILobEnableBuffering(svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator):sword;cdecl;external ocilib name 'OCILobEnableBuffering';
  5741. function OCILobErase(svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; amount:Pub4; offset:ub4):sword;cdecl;external ocilib name 'OCILobErase';
  5742. function OCILobFileClose(svchp:POCISvcCtx; errhp:POCIError; filep:POCILobLocator):sword;cdecl;external ocilib name 'OCILobFileClose';
  5743. function OCILobFileCloseAll(svchp:POCISvcCtx; errhp:POCIError):sword;cdecl;external ocilib name 'OCILobFileCloseAll';
  5744. function OCILobFileExists(svchp:POCISvcCtx; errhp:POCIError; filep:POCILobLocator; flag:Pboolean):sword;cdecl;external ocilib name 'OCILobFileExists';
  5745. function OCILobFileGetName(envhp:POCIEnv; errhp:POCIError; filep:POCILobLocator; dir_alias:POraText; d_length:Pub2;
  5746. filename:POraText; f_length:Pub2):sword;cdecl;external ocilib name 'OCILobFileGetName';
  5747. function OCILobFileIsOpen(svchp:POCISvcCtx; errhp:POCIError; filep:POCILobLocator; flag:Pboolean):sword;cdecl;external ocilib name 'OCILobFileIsOpen';
  5748. function OCILobFileOpen(svchp:POCISvcCtx; errhp:POCIError; filep:POCILobLocator; mode:ub1):sword;cdecl;external ocilib name 'OCILobFileOpen';
  5749. function OCILobFileSetName(envhp:POCIEnv; errhp:POCIError; var filepp:POCILobLocator; dir_alias:POraText; d_length:ub2;
  5750. filename:POraText; f_length:ub2):sword;cdecl;external ocilib name 'OCILobFileSetName';
  5751. function OCILobFlushBuffer(svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; flag:ub4):sword;cdecl;external ocilib name 'OCILobFlushBuffer';
  5752. function OCILobFreeTemporary(svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator):sword;cdecl;external ocilib name 'OCILobFreeTemporary';
  5753. function OCILobGetChunkSize(svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; chunksizep:Pub4):sword;cdecl;external ocilib name 'OCILobGetChunkSize';
  5754. function OCILobGetLength(svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; lenp:Pub4):sword;cdecl;external ocilib name 'OCILobGetLength';
  5755. function OCILobIsEqual(envhp:POCIEnv; x:POCILobLocator; y:POCILobLocator; is_equal:Pboolean):sword;cdecl;external ocilib name 'OCILobIsEqual';
  5756. function OCILobIsOpen(svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; flag:Pboolean):sword;cdecl;external ocilib name 'OCILobIsOpen';
  5757. function OCILobIsTemporary(envp:POCIEnv; errhp:POCIError; locp:POCILobLocator; is_temporary:Pboolean):sword;cdecl;external ocilib name 'OCILobIsTemporary';
  5758. function OCILobLoadFromFile(svchp:POCISvcCtx; errhp:POCIError; dst_locp:POCILobLocator; src_filep:POCILobLocator; amount:ub4;
  5759. dst_offset:ub4; src_offset:ub4):sword;cdecl;external ocilib name 'OCILobLoadFromFile';
  5760. function OCILobLocatorAssign(svchp:POCISvcCtx; errhp:POCIError; src_locp:POCILobLocator; var dst_locpp:POCILobLocator):sword;cdecl;external ocilib name 'OCILobLocatorAssign';
  5761. function OCILobLocatorIsInit(envhp:POCIEnv; errhp:POCIError; locp:POCILobLocator; is_initialized:Pboolean):sword;cdecl;external ocilib name 'OCILobLocatorIsInit';
  5762. function OCILobOpen(svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; mode:ub1):sword;cdecl;external ocilib name 'OCILobOpen';
  5763. function OCILobRead(svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; amtp:Pub4; offset:ub4;
  5764. bufp:Pdvoid; bufl:ub4; ctxp:Pdvoid; cbfp:OCICallbackLobRead; csid:ub2;
  5765. csfrm:ub1):sword;cdecl;external ocilib name 'OCILobRead';
  5766. function OCILobTrim(svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; newlen:ub4):sword;cdecl;external ocilib name 'OCILobTrim';
  5767. function OCILobWrite(svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; amtp:Pub4; offset:ub4;
  5768. bufp:Pdvoid; buflen:ub4; piece:ub1; ctxp:Pdvoid; cbfp:OCICallbackLobWrite;
  5769. csid:ub2; csfrm:ub1):sword;cdecl;external ocilib name 'OCILobWrite';
  5770. function OCILobWriteAppend(svchp:POCISvcCtx; errhp:POCIError; lobp:POCILobLocator; amtp:Pub4; bufp:Pdvoid;
  5771. bufl:ub4; piece:ub1; ctxp:Pdvoid; cbfp:OCICallbackLobWrite; csid:ub2;
  5772. csfrm:ub1):sword;cdecl;external ocilib name 'OCILobWriteAppend';
  5773. function OCIBreak(hndlp:Pdvoid; errhp:POCIError):sword;cdecl;external ocilib name 'OCIBreak';
  5774. function OCIReset(hndlp:Pdvoid; errhp:POCIError):sword;cdecl;external ocilib name 'OCIReset';
  5775. function OCIServerVersion(hndlp:Pdvoid; errhp:POCIError; bufp:POraText; bufsz:ub4; hndltype:ub1):sword;cdecl;external ocilib name 'OCIServerVersion';
  5776. function OCIServerRelease(hndlp:Pdvoid; errhp:POCIError; bufp:POraText; bufsz:ub4; hndltype:ub1;
  5777. version:Pub4):sword;cdecl;external ocilib name 'OCIServerRelease';
  5778. function OCIAttrGet(trgthndlp:Pdvoid; trghndltyp:ub4; attributep:Pdvoid; sizep:Pub4; attrtype:ub4;
  5779. errhp:POCIError):sword;cdecl;external ocilib name 'OCIAttrGet';
  5780. function OCIAttrSet(trgthndlp:Pdvoid; trghndltyp:ub4; attributep:Pdvoid; size:ub4; attrtype:ub4;
  5781. errhp:POCIError):sword;cdecl;external ocilib name 'OCIAttrSet';
  5782. function OCISvcCtxToLda(svchp:POCISvcCtx; errhp:POCIError; ldap:PLda_Def):sword;cdecl;external ocilib name 'OCISvcCtxToLda';
  5783. function OCILdaToSvcCtx(var svchpp:POCISvcCtx; errhp:POCIError; ldap:PLda_Def):sword;cdecl;external ocilib name 'OCILdaToSvcCtx';
  5784. function OCIResultSetToStmt(rsetdp:POCIResult; errhp:POCIError):sword;cdecl;external ocilib name 'OCIResultSetToStmt';
  5785. function OCIFileClose(hndl:Pdvoid; err:POCIError; filep:POCIFileObject):sword;cdecl;external ocilib name 'OCIFileClose';
  5786. // function OCIUserCallbackRegister(hndlp:Pdvoid; _type:ub4; ehndlp:Pdvoid; callback:OCIUserCallback; ctxp:Pdvoid;
  5787. // fcode:ub4; when:ub4; ucbDesc:POCIUcb):sword;cdecl;external ocilib name 'OCIUserCallbackRegister';
  5788. // function OCIUserCallbackGet(hndlp:Pdvoid; _type:ub4; ehndlp:Pdvoid; fcode:ub4; when:ub4;
  5789. // callbackp:POCIUserCallback; ctxpp:PPdvoid; ucbDesc:POCIUcb):sword;cdecl;external ocilib name 'OCIUserCallbackGet';
  5790. function OCISharedLibInit(metaCtx:Pdvoid; libCtx:Pdvoid; argfmt:ub4; argc:sword; argv:PPdvoid;
  5791. envCallback:OCIEnvCallbackType):sword;cdecl;external ocilib name 'OCISharedLibInit';
  5792. function OCIFileExists(hndl:Pdvoid; err:POCIError; filename:POraText; path:POraText; flag:Pub1):sword;cdecl;external ocilib name 'OCIFileExists';
  5793. function OCIFileFlush(hndl:Pdvoid; err:POCIError; filep:POCIFileObject):sword;cdecl;external ocilib name 'OCIFileFlush';
  5794. function OCIFileGetLength(hndl:Pdvoid; err:POCIError; filename:POraText; path:POraText; lenp:Pubig_ora):sword;cdecl;external ocilib name 'OCIFileGetLength';
  5795. function OCIFileInit(hndl:Pdvoid; err:POCIError):sword;cdecl;external ocilib name 'OCIFileInit';
  5796. function OCIFileOpen(hndl:Pdvoid; err:POCIError; var filep:POCIFileObject; filename:POraText; path:POraText;
  5797. mode:ub4; create:ub4; _type:ub4):sword;cdecl;external ocilib name 'OCIFileOpen';
  5798. function OCIFileRead(hndl:Pdvoid; err:POCIError; filep:POCIFileObject; bufp:Pdvoid; bufl:ub4;
  5799. bytesread:Pub4):sword;cdecl;external ocilib name 'OCIFileRead';
  5800. function OCIFileSeek(hndl:Pdvoid; err:POCIError; filep:POCIFileObject; origin:uword; offset:ubig_ora;
  5801. dir:sb1):sword;cdecl;external ocilib name 'OCIFileSeek';
  5802. function OCIFileTerm(hndl:Pdvoid; err:POCIError):sword;cdecl;external ocilib name 'OCIFileTerm';
  5803. function OCIFileWrite(hndl:Pdvoid; err:POCIError; filep:POCIFileObject; bufp:Pdvoid; buflen:ub4;
  5804. byteswritten:Pub4):sword;cdecl;external ocilib name 'OCIFileWrite';
  5805. {$ifdef ORAXB8_DEFINED}
  5806. function OCILobCopy2(svchp:POCISvcCtx; errhp:POCIError; dst_locp:POCILobLocator; src_locp:POCILobLocator; amount:oraub8;
  5807. dst_offset:oraub8; src_offset:oraub8):sword;cdecl;external ocilib name 'OCILobCopy2';
  5808. function OCILobErase2(svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; amount:Poraub8; offset:oraub8):sword;cdecl;external ocilib name 'OCILobErase2';
  5809. function OCILobGetLength2(svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; lenp:Poraub8):sword;cdecl;external ocilib name 'OCILobGetLength2';
  5810. function OCILobLoadFromFile2(svchp:POCISvcCtx; errhp:POCIError; dst_locp:POCILobLocator; src_filep:POCILobLocator; amount:oraub8;
  5811. dst_offset:oraub8; src_offset:oraub8):sword;cdecl;external ocilib name 'OCILobLoadFromFile2';
  5812. function OCILobRead2(svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; byte_amtp:Poraub8; char_amtp:Poraub8;
  5813. offset:oraub8; bufp:Pdvoid; bufl:oraub8; piece:ub1; ctxp:Pdvoid;
  5814. cbfp:OCICallbackLobRead2; csid:ub2; csfrm:ub1):sword;cdecl;external ocilib name 'OCILobRead2';
  5815. function OCILobArrayRead(svchp:POCISvcCtx; errhp:POCIError; array_iter:Pub4; lobp_arr:PPOCILobLocator; byte_amt_arr:Poraub8;
  5816. char_amt_arr:Poraub8; offset_arr:Poraub8; bufp_arr:PPdvoid; bufl_arr:Poraub8; piece:ub1;
  5817. ctxp:Pdvoid; cbfp:OCICallbackLobArrayRead; csid:ub2; csfrm:ub1):sword;cdecl;external ocilib name 'OCILobArrayRead';
  5818. function OCILobTrim2(svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; newlen:oraub8):sword;cdecl;external ocilib name 'OCILobTrim2';
  5819. function OCILobWrite2(svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; byte_amtp:Poraub8; char_amtp:Poraub8;
  5820. offset:oraub8; bufp:Pdvoid; buflen:oraub8; piece:ub1; ctxp:Pdvoid;
  5821. cbfp:OCICallbackLobWrite2; csid:ub2; csfrm:ub1):sword;cdecl;external ocilib name 'OCILobWrite2';
  5822. function OCILobArrayWrite(svchp:POCISvcCtx; errhp:POCIError; array_iter:Pub4; lobp_arr:PPOCILobLocator; byte_amt_arr:Poraub8;
  5823. char_amt_arr:Poraub8; offset_arr:Poraub8; bufp_arr:PPdvoid; bufl_arr:Poraub8; piece:ub1;
  5824. ctxp:Pdvoid; cbfp:OCICallbackLobArrayWrite; csid:ub2; csfrm:ub1):sword;cdecl;external ocilib name 'OCILobArrayWrite';
  5825. function OCILobWriteAppend2(svchp:POCISvcCtx; errhp:POCIError; lobp:POCILobLocator; byte_amtp:Poraub8; char_amtp:Poraub8;
  5826. bufp:Pdvoid; bufl:oraub8; piece:ub1; ctxp:Pdvoid; cbfp:OCICallbackLobWrite2;
  5827. csid:ub2; csfrm:ub1):sword;cdecl;external ocilib name 'OCILobWriteAppend2';
  5828. function OCILobGetStorageLimit(svchp:POCISvcCtx; errhp:POCIError; lobp:POCILobLocator; limitp:Poraub8):sword;cdecl;external ocilib name 'OCILobGetStorageLimit';
  5829. {$endif}
  5830. {
  5831. ** Initialize the security package
  5832. }
  5833. function OCISecurityInitialize(sechandle:POCISecurity; error_handle:POCIError):sword;cdecl;external ocilib name 'OCISecurityInitialize';
  5834. function OCISecurityTerminate(sechandle:POCISecurity; error_handle:POCIError):sword;cdecl;external ocilib name 'OCISecurityTerminate';
  5835. function OCISecurityOpenWallet(osshandle:POCISecurity; error_handle:POCIError; wrllen:size_t; wallet_resource_locator:POraText; pwdlen:size_t;
  5836. password:POraText; wallet:PnzttWallet):sword;cdecl;external ocilib name 'OCISecurityOpenWallet';
  5837. function OCISecurityCloseWallet(osshandle:POCISecurity; error_handle:POCIError; wallet:PnzttWallet):sword;cdecl;external ocilib name 'OCISecurityCloseWallet';
  5838. function OCISecurityCreateWallet(osshandle:POCISecurity; error_handle:POCIError; wrllen:size_t; wallet_resource_locator:POraText; pwdlen:size_t;
  5839. password:POraText; wallet:PnzttWallet):sword;cdecl;external ocilib name 'OCISecurityCreateWallet';
  5840. function OCISecurityDestroyWallet(osshandle:POCISecurity; error_handle:POCIError; wrllen:size_t; wallet_resource_locator:POraText; pwdlen:size_t;
  5841. password:POraText):sword;cdecl;external ocilib name 'OCISecurityDestroyWallet';
  5842. function OCISecurityStorePersona(osshandle:POCISecurity; error_handle:POCIError; var persona:PnzttPersona; wallet:PnzttWallet):sword;cdecl;external ocilib name 'OCISecurityStorePersona';
  5843. function OCISecurityOpenPersona(osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona):sword;cdecl;external ocilib name 'OCISecurityOpenPersona';
  5844. function OCISecurityClosePersona(osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona):sword;cdecl;external ocilib name 'OCISecurityClosePersona';
  5845. function OCISecurityRemovePersona(osshandle:POCISecurity; error_handle:POCIError; var persona:PnzttPersona):sword;cdecl;external ocilib name 'OCISecurityRemovePersona';
  5846. function OCISecurityCreatePersona(osshandle:POCISecurity; error_handle:POCIError; identity_type:nzttIdentType; cipher_type:nzttCipherType; desc:PnzttPersonaDesc;
  5847. var persona:PnzttPersona):sword;cdecl;external ocilib name 'OCISecurityCreatePersona';
  5848. function OCISecuritySetProtection(osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; crypto_engine_function:nzttcef; data_unit_format:nztttdufmt;
  5849. protection_info:PnzttProtInfo):sword;cdecl;external ocilib name 'OCISecuritySetProtection';
  5850. function OCISecurityGetProtection(osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; crypto_engine_function:nzttcef; data_unit_format_ptr:Pnztttdufmt;
  5851. protection_info:PnzttProtInfo):sword;cdecl;external ocilib name 'OCISecurityGetProtection';
  5852. function OCISecurityRemoveIdentity(osshandle:POCISecurity; error_handle:POCIError; var identity_ptr:PnzttIdentity):sword;cdecl;external ocilib name 'OCISecurityRemoveIdentity';
  5853. function OCISecurityCreateIdentity(osshandle:POCISecurity; error_handle:POCIError; _type:nzttIdentType; desc:PnzttIdentityDesc; var identity_ptr:PnzttIdentity):sword;cdecl;external ocilib name 'OCISecurityCreateIdentity';
  5854. function OCISecurityAbortIdentity(osshandle:POCISecurity; error_handle:POCIError; var identity_ptr:PnzttIdentity):sword;cdecl;external ocilib name 'OCISecurityAbortIdentity';
  5855. function OCISecurityFreeIdentity(osshandle:POCISecurity; error_handle:POCIError; var identity_ptr:PnzttIdentity):sword;cdecl;external ocilib name 'OCISecurityFreeIdentity';
  5856. function OCISecurityStoreTrustedIdentity(osshandle:POCISecurity; error_handle:POCIError; var identity_ptr:PnzttIdentity; persona:PnzttPersona):sword;cdecl;external ocilib name 'OCISecurityStoreTrustedIdentity';
  5857. function OCISecuritySign(osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; signature_state:nzttces; input_length:size_t;
  5858. input:Pub1; buffer_block:PnzttBufferBlock):sword;cdecl;external ocilib name 'OCISecuritySign';
  5859. function OCISecuritySignExpansion(osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; inputlen:size_t; signature_length:Psize_t):sword;cdecl;external ocilib name 'OCISecuritySignExpansion';
  5860. function OCISecurityVerify(osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; signature_state:nzttces; siglen:size_t;
  5861. signature:Pub1; extracted_message:PnzttBufferBlock; verified:Pboolean; validated:Pboolean; var signing_party_identity:PnzttIdentity):sword;cdecl;external ocilib name 'OCISecurityVerify';
  5862. function OCISecurityValidate(osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; identity:PnzttIdentity; validated:Pboolean):sword;cdecl;external ocilib name 'OCISecurityValidate';
  5863. function OCISecuritySignDetached(osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; signature_state:nzttces; input_length:size_t;
  5864. input:Pub1; signature:PnzttBufferBlock):sword;cdecl;external ocilib name 'OCISecuritySignDetached';
  5865. function OCISecuritySignDetExpansion(osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; input_length:size_t; required_buffer_length:Psize_t):sword;cdecl;external ocilib name 'OCISecuritySignDetExpansion';
  5866. function OCISecurityVerifyDetached(osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; signature_state:nzttces; data_length:size_t;
  5867. data:Pub1; siglen:size_t; signature:Pub1; verified:Pboolean; validated:Pboolean;
  5868. var signing_party_identity:PnzttIdentity):sword;cdecl;external ocilib name 'OCISecurityVerifyDetached';
  5869. function OCISecurity_PKEncrypt(osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; number_of_recipients:size_t; recipient_list:PnzttIdentity;
  5870. encryption_state:nzttces; input_length:size_t; input:Pub1; encrypted_data:PnzttBufferBlock):sword;cdecl;external ocilib name 'OCISecurity_PKEncrypt';
  5871. function OCISecurityPKEncryptExpansion(osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; number_recipients:size_t; input_length:size_t;
  5872. buffer_length_required:Psize_t):sword;cdecl;external ocilib name 'OCISecurityPKEncryptExpansion';
  5873. function OCISecurityPKDecrypt(osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; encryption_state:nzttces; input_length:size_t;
  5874. input:Pub1; encrypted_data:PnzttBufferBlock):sword;cdecl;external ocilib name 'OCISecurityPKDecrypt';
  5875. function OCISecurityEncrypt(osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; encryption_state:nzttces; input_length:size_t;
  5876. input:Pub1; encrypted_data:PnzttBufferBlock):sword;cdecl;external ocilib name 'OCISecurityEncrypt';
  5877. function OCISecurityEncryptExpansion(osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; input_length:size_t; encrypted_data_length:Psize_t):sword;cdecl;external ocilib name 'OCISecurityEncryptExpansion';
  5878. function OCISecurityDecrypt(osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; decryption_state:nzttces; input_length:size_t;
  5879. input:Pub1; decrypted_data:PnzttBufferBlock):sword;cdecl;external ocilib name 'OCISecurityDecrypt';
  5880. function OCISecurityEnvelope(osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; number_of_recipients:size_t; identity:PnzttIdentity;
  5881. encryption_state:nzttces; input_length:size_t; input:Pub1; enveloped_data:PnzttBufferBlock):sword;cdecl;external ocilib name 'OCISecurityEnvelope';
  5882. function OCISecurityDeEnvelope(osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; decryption_state:nzttces; input_length:size_t;
  5883. input:Pub1; output_message:PnzttBufferBlock; verified:Pboolean; validated:Pboolean; var sender_identity:PnzttIdentity):sword;cdecl;external ocilib name 'OCISecurityDeEnvelope';
  5884. function OCISecurityKeyedHash(osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; hash_state:nzttces; input_length:size_t;
  5885. input:Pub1; keyed_hash:PnzttBufferBlock):sword;cdecl;external ocilib name 'OCISecurityKeyedHash';
  5886. function OCISecurityKeyedHashExpansion(osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; input_length:size_t; required_buffer_length:Psize_t):sword;cdecl;external ocilib name 'OCISecurityKeyedHashExpansion';
  5887. function OCISecurityHash(osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; hash_state:nzttces; input:size_t;
  5888. input_length:Pub1; hash:PnzttBufferBlock):sword;cdecl;external ocilib name 'OCISecurityHash';
  5889. function OCISecurityHashExpansion(osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; input_length:size_t; required_buffer_length:Psize_t):sword;cdecl;external ocilib name 'OCISecurityHashExpansion';
  5890. function OCISecuritySeedRandom(osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; seed_length:size_t; seed:Pub1):sword;cdecl;external ocilib name 'OCISecuritySeedRandom';
  5891. function OCISecurityRandomBytes(osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; number_of_bytes_desired:size_t; random_bytes:PnzttBufferBlock):sword;cdecl;external ocilib name 'OCISecurityRandomBytes';
  5892. function OCISecurityRandomNumber(osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; random_number_ptr:Puword):sword;cdecl;external ocilib name 'OCISecurityRandomNumber';
  5893. function OCISecurityInitBlock(osshandle:POCISecurity; error_handle:POCIError; buffer_block:PnzttBufferBlock):sword;cdecl;external ocilib name 'OCISecurityInitBlock';
  5894. function OCISecurityReuseBlock(osshandle:POCISecurity; error_handle:POCIError; buffer_block:PnzttBufferBlock):sword;cdecl;external ocilib name 'OCISecurityReuseBlock';
  5895. function OCISecurityPurgeBlock(osshandle:POCISecurity; error_handle:POCIError; buffer_block:PnzttBufferBlock):sword;cdecl;external ocilib name 'OCISecurityPurgeBlock';
  5896. function OCISecuritySetBlock(osshandle:POCISecurity; error_handle:POCIError; flags_to_set:uword; buffer_length:size_t; used_buffer_length:size_t;
  5897. buffer:Pub1; buffer_block:PnzttBufferBlock):sword;cdecl;external ocilib name 'OCISecuritySetBlock';
  5898. function OCISecurityGetIdentity(osshandle:POCISecurity; error_handle:POCIError; namelen:size_t; distinguished_name:POraText; var identity:PnzttIdentity):sword;cdecl;external ocilib name 'OCISecurityGetIdentity';
  5899. function OCIAQEnq(svchp:POCISvcCtx; errhp:POCIError; queue_name:POraText; enqopt:POCIAQEnqOptions; msgprop:POCIAQMsgProperties;
  5900. payload_tdo:POCIType; payload:PPdvoid; payload_ind:PPdvoid; var msgid:POCIRaw; flags:ub4):sword;cdecl;external ocilib name 'OCIAQEnq';
  5901. function OCIAQDeq(svchp:POCISvcCtx; errhp:POCIError; queue_name:POraText; deqopt:POCIAQDeqOptions; msgprop:POCIAQMsgProperties;
  5902. payload_tdo:POCIType; payload:PPdvoid; payload_ind:PPdvoid; var msgid: POCIRaw; flags:ub4):sword;cdecl;external ocilib name 'OCIAQDeq';
  5903. function OCIAQEnqArray(svchp:POCISvcCtx; errhp:POCIError; queue_name:POraText; enqopt:POCIAQEnqOptions; iters:Pub4;
  5904. var msgprop:POCIAQMsgProperties; payload_tdo:POCIType; payload:PPdvoid; payload_ind:PPdvoid; var msgid:POCIRaw;
  5905. ctxp:Pdvoid; enqcbfp:OCICallbackAQEnq; flags:ub4):sword;cdecl;external ocilib name 'OCIAQEnqArray';
  5906. function OCIAQDeqArray(svchp:POCISvcCtx; errhp:POCIError; queue_name:POraText; deqopt:POCIAQDeqOptions; iters:Pub4;
  5907. var msgprop:POCIAQMsgProperties; payload_tdo:POCIType; payload:PPdvoid; payload_ind:PPdvoid; var msgid:POCIRaw;
  5908. ctxp:Pdvoid; deqcbfp:OCICallbackAQDeq; flags:ub4):sword;cdecl;external ocilib name 'OCIAQDeqArray';
  5909. function OCIAQListen(svchp:POCISvcCtx; errhp:POCIError; var agent_list:POCIAQAgent; num_agents:ub4; wait:sb4;
  5910. var agent:POCIAQAgent; flags:ub4):sword;cdecl;external ocilib name 'OCIAQListen';
  5911. function OCIAQListen2(svchp:POCISvcCtx; errhp:POCIError; var agent_list:POCIAQAgent; num_agents:ub4; lopts:POCIAQListenOpts;
  5912. var agent:POCIAQAgent; lmops:POCIAQLisMsgProps; flags:ub4):sword;cdecl;external ocilib name 'OCIAQListen2';
  5913. function OCIExtractInit(hndl:Pdvoid; err:POCIError):sword;cdecl;external ocilib name 'OCIExtractInit';
  5914. function OCIExtractTerm(hndl:Pdvoid; err:POCIError):sword;cdecl;external ocilib name 'OCIExtractTerm';
  5915. function OCIExtractReset(hndl:Pdvoid; err:POCIError):sword;cdecl;external ocilib name 'OCIExtractReset';
  5916. function OCIExtractSetNumKeys(hndl:Pdvoid; err:POCIError; numkeys:uword):sword;cdecl;external ocilib name 'OCIExtractSetNumKeys';
  5917. function OCIExtractSetKey(hndl:Pdvoid; err:POCIError; name:POraText; _type:ub1; flag:ub4;
  5918. defval:Pdvoid; intrange:Psb4; var strlist:POraText):sword;cdecl;external ocilib name 'OCIExtractSetKey';
  5919. function OCIExtractFromFile(hndl:Pdvoid; err:POCIError; flag:ub4; filename:POraText):sword;cdecl;external ocilib name 'OCIExtractFromFile';
  5920. function OCIExtractFromStr(hndl:Pdvoid; err:POCIError; flag:ub4; input:POraText):sword;cdecl;external ocilib name 'OCIExtractFromStr';
  5921. function OCIExtractToInt(hndl:Pdvoid; err:POCIError; keyname:POraText; valno:uword; retval:Psb4):sword;cdecl;external ocilib name 'OCIExtractToInt';
  5922. function OCIExtractToBool(hndl:Pdvoid; err:POCIError; keyname:POraText; valno:uword; retval:Pub1):sword;cdecl;external ocilib name 'OCIExtractToBool';
  5923. function OCIExtractToStr(hndl:Pdvoid; err:POCIError; keyname:POraText; valno:uword; retval:POraText;
  5924. buflen:uword):sword;cdecl;external ocilib name 'OCIExtractToStr';
  5925. function OCIExtractToOCINum(hndl:Pdvoid; err:POCIError; keyname:POraText; valno:uword; retval:POCINumber):sword;cdecl;external ocilib name 'OCIExtractToOCINum';
  5926. function OCIExtractToList(hndl:Pdvoid; err:POCIError; numkeys:Puword):sword;cdecl;external ocilib name 'OCIExtractToList';
  5927. function OCIExtractFromList(hndl:Pdvoid; err:POCIError; index:uword; var name:POraText; _type:Pub1;
  5928. numvals:Puword; values:PPPdvoid):sword;cdecl;external ocilib name 'OCIExtractFromList';
  5929. { Memory Related Service Interfaces }
  5930. function OCIMemoryAlloc(hdl:Pdvoid; err:POCIError; mem:PPdvoid; dur:OCIDuration; size:ub4;
  5931. flags:ub4):sword;cdecl;external ocilib name 'OCIMemoryAlloc';
  5932. function OCIMemoryResize(hdl:Pdvoid; err:POCIError; mem:PPdvoid; newsize:ub4; flags:ub4):sword;cdecl;external ocilib name 'OCIMemoryResize';
  5933. function OCIMemoryFree(hdl:Pdvoid; err:POCIError; mem:Pdvoid):sword;cdecl;external ocilib name 'OCIMemoryFree';
  5934. function OCIContextSetValue(hdl:Pdvoid; err:POCIError; duration:OCIDuration; key:Pub1; keylen:ub1;
  5935. ctx_value:Pdvoid):sword;cdecl;external ocilib name 'OCIContextSetValue';
  5936. function OCIContextGetValue(hdl:Pdvoid; err:POCIError; key:Pub1; keylen:ub1; ctx_value:PPdvoid):sword;cdecl;external ocilib name 'OCIContextGetValue';
  5937. function OCIContextClearValue(hdl:Pdvoid; err:POCIError; key:Pub1; keylen:ub1):sword;cdecl;external ocilib name 'OCIContextClearValue';
  5938. function OCIContextGenerateKey(hdl:Pdvoid; err:POCIError; key:Pub4):sword;cdecl;external ocilib name 'OCIContextGenerateKey';
  5939. function OCIMemorySetCurrentIDs(hdl:Pdvoid; err:POCIError; curr_session_id:ub4; curr_trans_id:ub4; curr_stmt_id:ub4):sword;cdecl;external ocilib name 'OCIMemorySetCurrentIDs';
  5940. function OCIPicklerTdsCtxInit(env:POCIEnv; err:POCIError; var tdsc:POCIPicklerTdsCtx):sword;cdecl;external ocilib name 'OCIPicklerTdsCtxInit';
  5941. function OCIPicklerTdsCtxFree(env:POCIEnv; err:POCIError; tdsc:POCIPicklerTdsCtx):sword;cdecl;external ocilib name 'OCIPicklerTdsCtxFree';
  5942. function OCIPicklerTdsInit(env:POCIEnv; err:POCIError; tdsc:POCIPicklerTdsCtx; var tdsh:POCIPicklerTds):sword;cdecl;external ocilib name 'OCIPicklerTdsInit';
  5943. function OCIPicklerTdsFree(env:POCIEnv; err:POCIError; tdsh:POCIPicklerTds):sword;cdecl;external ocilib name 'OCIPicklerTdsFree';
  5944. function OCIPicklerTdsCreateElementNumber(env:POCIEnv; err:POCIError; tdsh:POCIPicklerTds; prec:ub1; scale:sb1;
  5945. elt:POCIPicklerTdsElement):sword;cdecl;external ocilib name 'OCIPicklerTdsCreateElementNumber';
  5946. function OCIPicklerTdsCreateElementChar(env:POCIEnv; err:POCIError; tdsh:POCIPicklerTds; len:ub2; elt:POCIPicklerTdsElement):sword;cdecl;external ocilib name 'OCIPicklerTdsCreateElementChar';
  5947. function OCIPicklerTdsCreateElementVarchar(env:POCIEnv; err:POCIError; tdsh:POCIPicklerTds; len:ub2; elt:POCIPicklerTdsElement):sword;cdecl;external ocilib name 'OCIPicklerTdsCreateElementVarchar';
  5948. function OCIPicklerTdsCreateElementRaw(env:POCIEnv; err:POCIError; tdsh:POCIPicklerTds; len:ub2; elt:POCIPicklerTdsElement):sword;cdecl;external ocilib name 'OCIPicklerTdsCreateElementRaw';
  5949. function OCIPicklerTdsCreateElement(env:POCIEnv; err:POCIError; tdsh:POCIPicklerTds; dty:OCITypeCode; elt:POCIPicklerTdsElement):sword;cdecl;external ocilib name 'OCIPicklerTdsCreateElement';
  5950. function OCIPicklerTdsAddAttr(env:POCIEnv; err:POCIError; tdsh:POCIPicklerTds; elt:OCIPicklerTdsElement):sword;cdecl;external ocilib name 'OCIPicklerTdsAddAttr';
  5951. function OCIPicklerTdsGenerate(env:POCIEnv; err:POCIError; tdsh:POCIPicklerTds):sword;cdecl;external ocilib name 'OCIPicklerTdsGenerate';
  5952. function OCIPicklerTdsGetAttr(env:POCIEnv; err:POCIError; tdsh:POCIPicklerTds; attrno:ub1; typ:POCITypeCode;
  5953. len:Pub2):sword;cdecl;external ocilib name 'OCIPicklerTdsGetAttr';
  5954. function OCIPicklerFdoInit(env:POCIEnv; err:POCIError; var fdoh:POCIPicklerFdo):sword;cdecl;external ocilib name 'OCIPicklerFdoInit';
  5955. function OCIPicklerFdoFree(env:POCIEnv; err:POCIError; fdoh:POCIPicklerFdo):sword;cdecl;external ocilib name 'OCIPicklerFdoFree';
  5956. function OCIPicklerImageInit(env:POCIEnv; err:POCIError; fdoh:POCIPicklerFdo; tdsh:POCIPicklerTds; var imgh:POCIPicklerImage):sword;cdecl;external ocilib name 'OCIPicklerImageInit';
  5957. function OCIPicklerImageFree(env:POCIEnv; err:POCIError; imgh:POCIPicklerImage):sword;cdecl;external ocilib name 'OCIPicklerImageFree';
  5958. function OCIPicklerImageAddScalar(env:POCIEnv; err:POCIError; imgh:POCIPicklerImage; scalar:Pdvoid; len:ub4):sword;cdecl;external ocilib name 'OCIPicklerImageAddScalar';
  5959. function OCIPicklerImageAddNullScalar(env:POCIEnv; err:POCIError; imgh:POCIPicklerImage):sword;cdecl;external ocilib name 'OCIPicklerImageAddNullScalar';
  5960. function OCIPicklerImageGenerate(env:POCIEnv; err:POCIError; imgh:POCIPicklerImage):sword;cdecl;external ocilib name 'OCIPicklerImageGenerate';
  5961. function OCIPicklerImageGetScalarSize(env:POCIEnv; err:POCIError; imgh:POCIPicklerImage; attrno:ub4; size:Pub4):sword;cdecl;external ocilib name 'OCIPicklerImageGetScalarSize';
  5962. function OCIPicklerImageGetScalar(env:POCIEnv; err:POCIError; imgh:POCIPicklerImage; attrno:ub4; buf:Pdvoid;
  5963. len:Pub4; ind:POCIInd):sword;cdecl;external ocilib name 'OCIPicklerImageGetScalar';
  5964. function OCIPicklerImageCollBegin(env:POCIEnv; err:POCIError; imgh:POCIPicklerImage; colltdsh:POCIPicklerTds):sword;cdecl;external ocilib name 'OCIPicklerImageCollBegin';
  5965. function OCIPicklerImageCollAddScalar(env:POCIEnv; err:POCIError; imgh:POCIPicklerImage; scalar:Pdvoid; buflen:ub4;
  5966. ind:OCIInd):sword;cdecl;external ocilib name 'OCIPicklerImageCollAddScalar';
  5967. function OCIPicklerImageCollEnd(env:POCIEnv; err:POCIError; imgh:POCIPicklerImage):sword;cdecl;external ocilib name 'OCIPicklerImageCollEnd';
  5968. { should take svcctx for locator stuff }
  5969. function OCIPicklerImageCollBeginScan(env:POCIEnv; err:POCIError; imgh:POCIPicklerImage; coll_tdsh:POCIPicklerTds; attrnum:ub4;
  5970. startidx:ub4; ind:POCIInd):sword;cdecl;external ocilib name 'OCIPicklerImageCollBeginScan';
  5971. function OCIPicklerImageCollGetScalarSize(env:POCIEnv; err:POCIError; coll_tdsh:POCIPicklerTds; size:Pub4):sword;cdecl;external ocilib name 'OCIPicklerImageCollGetScalarSize';
  5972. function OCIPicklerImageCollGetScalar(env:POCIEnv; err:POCIError; imgh:POCIPicklerImage; buf:Pdvoid; buflen:Pub4;
  5973. ind:POCIInd):sword;cdecl;external ocilib name 'OCIPicklerImageCollGetScalar';
  5974. function OCIAnyDataGetType(svchp:POCISvcCtx; errhp:POCIError; sdata:POCIAnyData; tc:POCITypeCode; var _type:POCIType):sword;cdecl;external ocilib name 'OCIAnyDataGetType';
  5975. function OCIAnyDataIsNull(svchp:POCISvcCtx; errhp:POCIError; sdata:POCIAnyData; isnull:Pboolean):sword;cdecl;external ocilib name 'OCIAnyDataIsNull';
  5976. function OCIAnyDataConvert(svchp:POCISvcCtx; errhp:POCIError; tc:OCITypeCode; _type:POCIType; dur:OCIDuration;
  5977. ind:Pdvoid; data_val:Pdvoid; len:ub4; var sdata:POCIAnyData):sword;cdecl;external ocilib name 'OCIAnyDataConvert';
  5978. function OCIAnyDataBeginCreate(svchp:POCISvcCtx; errhp:POCIError; tc:OCITypeCode; _type:POCIType; dur:OCIDuration;
  5979. var sdata:POCIAnyData):sword;cdecl;external ocilib name 'OCIAnyDataBeginCreate';
  5980. function OCIAnyDataDestroy(svchp:POCISvcCtx; errhp:POCIError; sdata:POCIAnyData):sword;cdecl;external ocilib name 'OCIAnyDataDestroy';
  5981. function OCIAnyDataAttrSet(svchp:POCISvcCtx; errhp:POCIError; sdata:POCIAnyData; tc:OCITypeCode; _type:POCIType;
  5982. ind:Pdvoid; attr_val:Pdvoid; length:ub4; is_any:boolean):sword;cdecl;external ocilib name 'OCIAnyDataAttrSet';
  5983. function OCIAnyDataCollAddElem(svchp:POCISvcCtx; errhp:POCIError; sdata:POCIAnyData; tc:OCITypeCode; _type:POCIType;
  5984. ind:Pdvoid; attr_val:Pdvoid; length:ub4; is_any:boolean; last_elem:boolean):sword;cdecl;external ocilib name 'OCIAnyDataCollAddElem';
  5985. function OCIAnyDataEndCreate(svchp:POCISvcCtx; errhp:POCIError; sdata:POCIAnyData):sword;cdecl;external ocilib name 'OCIAnyDataEndCreate';
  5986. function OCIAnyDataAccess(svchp:POCISvcCtx; errhp:POCIError; sdata:POCIAnyData; tc:OCITypeCode; _type:POCIType;
  5987. ind:Pdvoid; attr_val:Pdvoid; length:Pub4):sword;cdecl;external ocilib name 'OCIAnyDataAccess';
  5988. function OCIAnyDataGetCurrAttrNum(svchp:POCISvcCtx; errhp:POCIError; sdata:POCIAnyData; attrnum:Pub4):sword;cdecl;external ocilib name 'OCIAnyDataGetCurrAttrNum';
  5989. function OCIAnyDataAttrGet(svchp:POCISvcCtx; errhp:POCIError; sdata:POCIAnyData; tc:OCITypeCode; _type:POCIType;
  5990. ind:Pdvoid; attr_val:Pdvoid; length:Pub4; is_any:boolean):sword;cdecl;external ocilib name 'OCIAnyDataAttrGet';
  5991. function OCIAnyDataCollGetElem(svchp:POCISvcCtx; errhp:POCIError; sdata:POCIAnyData; tc:OCITypeCode; _type:POCIType;
  5992. ind:Pdvoid; celem_val:Pdvoid; length:Pub4; is_any:boolean):sword;cdecl;external ocilib name 'OCIAnyDataCollGetElem';
  5993. {$ELSE}
  5994. var OCIInitialize : function (mode:ub4; ctxp:Pdvoid; malocfp:tmalocfp; ralocfp:tralocfp;mfreefp:tmfreefp ):sword;cdecl;
  5995. OCITerminate : function (mode:ub4):sword;cdecl;
  5996. OCIEnvCreate : function (var envp:POCIEnv; mode:ub4; ctxp:Pdvoid; malocfp:tmalocfp; ralocfp:tralocfp;
  5997. mfreefp:tmfreefp; xtramem_sz:size_t; usrmempp:PPdvoid):sword;cdecl;
  5998. OCIEnvNlsCreate : function (var envp:POCIEnv; mode:ub4; ctxp:Pdvoid; malocfp:tmalocfp; ralocfp:tralocfp;
  5999. mfreefp:tmfreefp; xtramem_sz:size_t; usrmempp:PPdvoid; charset:ub2; ncharset:ub2):sword;cdecl;
  6000. OCIFEnvCreate : function (var envp:POCIEnv; mode:ub4; ctxp:Pdvoid; malocfp:tmalocfp; ralocfp:tralocfp;
  6001. mfreefp:tmfreefp; xtramem_sz:size_t; usrmempp:PPdvoid; fupg:Pdvoid):sword;cdecl;
  6002. OCIHandleAlloc : function (parenth:Pdvoid; var hndlpp:Pdvoid; _type:ub4; xtramem_sz:size_t; usrmempp:PPdvoid):sword;cdecl;
  6003. OCIHandleFree : function (hndlp:Pdvoid; _type:ub4):sword;cdecl;
  6004. OCIDescriptorAlloc : function (parenth:Pdvoid; descpp:PPdvoid; _type:ub4; xtramem_sz:size_t; usrmempp:PPdvoid):sword;cdecl;
  6005. OCIDescriptorFree : function (descp:Pdvoid; _type:ub4):sword;cdecl;
  6006. OCIEnvInit : function (var envp:POCIEnv; mode:ub4; xtramem_sz:size_t; usrmempp:PPdvoid):sword;cdecl;
  6007. OCIServerAttach : function (srvhp:POCIServer; errhp:POCIError; dblink:POraText; dblink_len:sb4; mode:ub4):sword;cdecl;
  6008. OCIServerDetach : function (srvhp:POCIServer; errhp:POCIError; mode:ub4):sword;cdecl;
  6009. OCISessionBegin : function (svchp:POCISvcCtx; errhp:POCIError; usrhp:POCISession; credt:ub4; mode:ub4):sword;cdecl;
  6010. OCISessionEnd : function (svchp:POCISvcCtx; errhp:POCIError; usrhp:POCISession; mode:ub4):sword;cdecl;
  6011. OCILogon : function (envhp:POCIEnv; errhp:POCIError;var svchp:POCISvcCtx; username:POraText; uname_len:ub4;
  6012. password:POraText; passwd_len:ub4; dbname:POraText; dbname_len:ub4):sword;cdecl;
  6013. OCILogon2 : function (envhp:POCIEnv; errhp:POCIError; var svchp:POCISvcCtx; username:POraText; uname_len:ub4;
  6014. password:POraText; passwd_len:ub4; dbname:POraText; dbname_len:ub4; mode:ub4):sword;cdecl;
  6015. OCILogoff : function (svchp:POCISvcCtx; errhp:POCIError):sword;cdecl;
  6016. OCIPasswordChange : function (svchp:POCISvcCtx; errhp:POCIError; user_name:POraText; usernm_len:ub4; opasswd:POraText;
  6017. opasswd_len:ub4; npasswd:POraText; npasswd_len:ub4; mode:ub4):sword;cdecl;
  6018. OCIStmtPrepare : function (stmtp:POCIStmt; errhp:POCIError; stmt:POraText; stmt_len:ub4; language:ub4;
  6019. mode:ub4):sword;cdecl;
  6020. OCIStmtPrepare2 : function (svchp:POCISvcCtx; var stmtp:POCIStmt; errhp:POCIError; stmt:POraText; stmt_len:ub4;
  6021. key:POraText; key_len:ub4; language:ub4; mode:ub4):sword;cdecl;
  6022. OCIStmtRelease : function (stmtp:POCIStmt; errhp:POCIError; key:POraText; key_len:ub4; mode:ub4):sword;cdecl;
  6023. OCIBindByPos : function (stmtp:POCIStmt; var bindp:POCIBind; errhp:POCIError; position:ub4; valuep:Pdvoid;
  6024. value_sz:sb4; dty:ub2; indp:Pdvoid; alenp:Pub2; rcodep:Pub2;
  6025. maxarr_len:ub4; curelep:Pub4; mode:ub4):sword;cdecl;
  6026. OCIBindByName : function (stmtp:POCIStmt; var bindp: POCIBind; errhp:POCIError; placeholder:POraText; placeh_len:sb4;
  6027. valuep:Pdvoid; value_sz:sb4; dty:ub2; indp:Pdvoid; alenp:Pub2;
  6028. rcodep:Pub2; maxarr_len:ub4; curelep:Pub4; mode:ub4):sword;cdecl;
  6029. OCIBindObject : function (bindp:POCIBind; errhp:POCIError; _type:POCIType; pgvpp:PPdvoid; pvszsp:Pub4;
  6030. indpp:PPdvoid; indszp:Pub4):sword;cdecl;
  6031. OCIBindDynamic : function (bindp:POCIBind; errhp:POCIError; ictxp:Pdvoid; icbfp:OCICallbackInBind; octxp:Pdvoid;
  6032. ocbfp:OCICallbackOutBind):sword;cdecl;
  6033. OCIBindArrayOfStruct : function (bindp:POCIBind; errhp:POCIError; pvskip:ub4; indskip:ub4; alskip:ub4;
  6034. rcskip:ub4):sword;cdecl;
  6035. OCIStmtGetPieceInfo : function (stmtp:POCIStmt; errhp:POCIError; hndlpp:PPdvoid; typep:Pub4; in_outp:Pub1;
  6036. iterp:Pub4; idxp:Pub4; piecep:Pub1):sword;cdecl;
  6037. OCIStmtSetPieceInfo : function (hndlp:Pdvoid; _type:ub4; errhp:POCIError; bufp:Pdvoid; alenp:Pub4;
  6038. piece:ub1; indp:Pdvoid; rcodep:Pub2):sword;cdecl;
  6039. OCIStmtExecute : function (svchp:POCISvcCtx; stmtp:POCIStmt; errhp:POCIError; iters:ub4; rowoff:ub4;
  6040. snap_in:POCISnapshot; snap_out:POCISnapshot; mode:ub4):sword;cdecl;
  6041. OCIDefineByPos : function (stmtp:POCIStmt; var defnp:POCIDefine; errhp:POCIError; position:ub4; valuep:Pdvoid;
  6042. value_sz:sb4; dty:ub2; indp:Pdvoid; rlenp:Pub2; rcodep:Pub2;
  6043. mode:ub4):sword;cdecl;
  6044. OCIDefineObject : function (defnp:POCIDefine; errhp:POCIError; _type:POCIType; pgvpp:PPdvoid; pvszsp:Pub4;
  6045. indpp:PPdvoid; indszp:Pub4):sword;cdecl;
  6046. OCIDefineDynamic : function (defnp:POCIDefine; errhp:POCIError; octxp:Pdvoid; ocbfp:OCICallbackDefine):sword;cdecl;
  6047. OCIRowidToChar : function (rowidDesc:POCIRowid; outbfp:POraText; outbflp:Pub2; errhp:POCIError):sword;cdecl;
  6048. OCIDefineArrayOfStruct : function (defnp:POCIDefine; errhp:POCIError; pvskip:ub4; indskip:ub4; rlskip:ub4;
  6049. rcskip:ub4):sword;cdecl;
  6050. OCIStmtFetch : function (stmtp:POCIStmt; errhp:POCIError; nrows:ub4; orientation:ub2; mode:ub4):sword;cdecl;
  6051. OCIStmtFetch2 : function (stmtp:POCIStmt; errhp:POCIError; nrows:ub4; orientation:ub2; scrollOffset:sb4;
  6052. mode:ub4):sword;cdecl;
  6053. OCIStmtGetBindInfo : function (stmtp:POCIStmt; errhp:POCIError; size:ub4; startloc:ub4; found:Psb4;
  6054. bvnp:array of POraText; bvnl:array of ub1; invp:array of POraText; inpl:array of ub1; dupl:array of ub1;
  6055. var hndl:POCIBind):sword;cdecl;
  6056. OCIDescribeAny : function (svchp:POCISvcCtx; errhp:POCIError; objptr:Pdvoid; objnm_len:ub4; objptr_typ:ub1;
  6057. info_level:ub1; objtyp:ub1; dschp:POCIDescribe):sword;cdecl;
  6058. OCIParamGet : function (hndlp:Pdvoid; htype:ub4; errhp:POCIError; var parmdpp:Pdvoid; pos:ub4):sword;cdecl;
  6059. OCIParamSet : function (hdlp:Pdvoid; htyp:ub4; errhp:POCIError; dscp:Pdvoid; dtyp:ub4;
  6060. pos:ub4):sword;cdecl;
  6061. OCITransStart : function (svchp:POCISvcCtx; errhp:POCIError; timeout:uword; flags:ub4):sword;cdecl;
  6062. OCITransDetach : function (svchp:POCISvcCtx; errhp:POCIError; flags:ub4):sword;cdecl;
  6063. OCITransCommit : function (svchp:POCISvcCtx; errhp:POCIError; flags:ub4):sword;cdecl;
  6064. OCITransRollback : function (svchp:POCISvcCtx; errhp:POCIError; flags:ub4):sword;cdecl;
  6065. OCITransPrepare : function (svchp:POCISvcCtx; errhp:POCIError; flags:ub4):sword;cdecl;
  6066. OCITransMultiPrepare : function (svchp:POCISvcCtx; numBranches:ub4; var txns:POCITrans; var errhp:POCIError):sword;cdecl;
  6067. OCITransForget : function (svchp:POCISvcCtx; errhp:POCIError; flags:ub4):sword;cdecl;
  6068. OCIErrorGet : function (hndlp:Pdvoid; recordno:ub4; sqlstate:POraText; var errcodep:sb4; bufp:POraText;
  6069. bufsiz:ub4; _type:ub4):sword;cdecl;
  6070. OCILobAppend : function (svchp:POCISvcCtx; errhp:POCIError; dst_locp:POCILobLocator; src_locp:POCILobLocator):sword;cdecl;
  6071. OCILobAssign : function (envhp:POCIEnv; errhp:POCIError; src_locp:POCILobLocator; var dst_locpp:POCILobLocator):sword;cdecl;
  6072. OCILobCharSetForm : function (envhp:POCIEnv; errhp:POCIError; locp:POCILobLocator; csfrm:Pub1):sword;cdecl;
  6073. OCILobCharSetId : function (envhp:POCIEnv; errhp:POCIError; locp:POCILobLocator; csid:Pub2):sword;cdecl;
  6074. OCILobCopy : function (svchp:POCISvcCtx; errhp:POCIError; dst_locp:POCILobLocator; src_locp:POCILobLocator; amount:ub4;
  6075. dst_offset:ub4; src_offset:ub4):sword;cdecl;
  6076. OCILobCreateTemporary : function (svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; csid:ub2; csfrm:ub1;
  6077. lobtype:ub1; cache:boolean; duration:OCIDuration):sword;cdecl;
  6078. OCILobClose : function (svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator):sword;cdecl;
  6079. OCILobDisableBuffering : function (svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator):sword;cdecl;
  6080. OCILobEnableBuffering : function (svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator):sword;cdecl;
  6081. OCILobErase : function (svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; amount:Pub4; offset:ub4):sword;cdecl;
  6082. OCILobFileClose : function (svchp:POCISvcCtx; errhp:POCIError; filep:POCILobLocator):sword;cdecl;
  6083. OCILobFileCloseAll : function (svchp:POCISvcCtx; errhp:POCIError):sword;cdecl;
  6084. OCILobFileExists : function (svchp:POCISvcCtx; errhp:POCIError; filep:POCILobLocator; flag:Pboolean):sword;cdecl;
  6085. OCILobFileGetName : function (envhp:POCIEnv; errhp:POCIError; filep:POCILobLocator; dir_alias:POraText; d_length:Pub2;
  6086. filename:POraText; f_length:Pub2):sword;cdecl;
  6087. OCILobFileIsOpen : function (svchp:POCISvcCtx; errhp:POCIError; filep:POCILobLocator; flag:Pboolean):sword;cdecl;
  6088. OCILobFileOpen : function (svchp:POCISvcCtx; errhp:POCIError; filep:POCILobLocator; mode:ub1):sword;cdecl;
  6089. OCILobFileSetName : function (envhp:POCIEnv; errhp:POCIError; var filepp:POCILobLocator; dir_alias:POraText; d_length:ub2;
  6090. filename:POraText; f_length:ub2):sword;cdecl;
  6091. OCILobFlushBuffer : function (svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; flag:ub4):sword;cdecl;
  6092. OCILobFreeTemporary : function (svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator):sword;cdecl;
  6093. OCILobGetChunkSize : function (svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; chunksizep:Pub4):sword;cdecl;
  6094. OCILobGetLength : function (svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; lenp:Pub4):sword;cdecl;
  6095. OCILobIsEqual : function (envhp:POCIEnv; x:POCILobLocator; y:POCILobLocator; is_equal:Pboolean):sword;cdecl;
  6096. OCILobIsOpen : function (svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; flag:Pboolean):sword;cdecl;
  6097. OCILobIsTemporary : function (envp:POCIEnv; errhp:POCIError; locp:POCILobLocator; is_temporary:Pboolean):sword;cdecl;
  6098. OCILobLoadFromFile : function (svchp:POCISvcCtx; errhp:POCIError; dst_locp:POCILobLocator; src_filep:POCILobLocator; amount:ub4;
  6099. dst_offset:ub4; src_offset:ub4):sword;cdecl;
  6100. OCILobLocatorAssign : function (svchp:POCISvcCtx; errhp:POCIError; src_locp:POCILobLocator; var dst_locpp:POCILobLocator):sword;cdecl;
  6101. OCILobLocatorIsInit : function (envhp:POCIEnv; errhp:POCIError; locp:POCILobLocator; is_initialized:Pboolean):sword;cdecl;
  6102. OCILobOpen : function (svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; mode:ub1):sword;cdecl;
  6103. OCILobRead : function (svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; amtp:Pub4; offset:ub4;
  6104. bufp:Pdvoid; bufl:ub4; ctxp:Pdvoid; cbfp:OCICallbackLobRead; csid:ub2;
  6105. csfrm:ub1):sword;cdecl;
  6106. OCILobTrim : function (svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; newlen:ub4):sword;cdecl;
  6107. OCILobWrite : function (svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; amtp:Pub4; offset:ub4;
  6108. bufp:Pdvoid; buflen:ub4; piece:ub1; ctxp:Pdvoid; cbfp:OCICallbackLobWrite;
  6109. csid:ub2; csfrm:ub1):sword;cdecl;
  6110. OCILobWriteAppend : function (svchp:POCISvcCtx; errhp:POCIError; lobp:POCILobLocator; amtp:Pub4; bufp:Pdvoid;
  6111. bufl:ub4; piece:ub1; ctxp:Pdvoid; cbfp:OCICallbackLobWrite; csid:ub2;
  6112. csfrm:ub1):sword;cdecl;
  6113. OCIBreak : function (hndlp:Pdvoid; errhp:POCIError):sword;cdecl;
  6114. OCIReset : function (hndlp:Pdvoid; errhp:POCIError):sword;cdecl;
  6115. OCIServerVersion : function (hndlp:Pdvoid; errhp:POCIError; bufp:POraText; bufsz:ub4; hndltype:ub1):sword;cdecl;
  6116. OCIServerRelease : function (hndlp:Pdvoid; errhp:POCIError; bufp:POraText; bufsz:ub4; hndltype:ub1;
  6117. version:Pub4):sword;cdecl;
  6118. OCIAttrGet : function (trgthndlp:Pdvoid; trghndltyp:ub4; attributep:Pdvoid; sizep:Pub4; attrtype:ub4;
  6119. errhp:POCIError):sword;cdecl;
  6120. OCIAttrSet : function (trgthndlp:Pdvoid; trghndltyp:ub4; attributep:Pdvoid; size:ub4; attrtype:ub4;
  6121. errhp:POCIError):sword;cdecl;
  6122. OCISvcCtxToLda : function (svchp:POCISvcCtx; errhp:POCIError; ldap:PLda_Def):sword;cdecl;
  6123. OCILdaToSvcCtx : function (var svchpp:POCISvcCtx; errhp:POCIError; ldap:PLda_Def):sword;cdecl;
  6124. OCIResultSetToStmt : function (rsetdp:POCIResult; errhp:POCIError):sword;cdecl;
  6125. OCIFileClose : function (hndl:Pdvoid; err:POCIError; filep:POCIFileObject):sword;cdecl;
  6126. // OCIUserCallbackRegister : function (hndlp:Pdvoid; _type:ub4; ehndlp:Pdvoid; callback:OCIUserCallback; ctxp:Pdvoid;
  6127. // fcode:ub4; when:ub4; ucbDesc:POCIUcb):sword;cdecl;external ocilib name 'OCIUserCallbackRegister';
  6128. // OCIUserCallbackGet : function (hndlp:Pdvoid; _type:ub4; ehndlp:Pdvoid; fcode:ub4; when:ub4;
  6129. // callbackp:POCIUserCallback; ctxpp:PPdvoid; ucbDesc:POCIUcb):sword;cdecl;external ocilib name 'OCIUserCallbackGet';
  6130. OCISharedLibInit : function (metaCtx:Pdvoid; libCtx:Pdvoid; argfmt:ub4; argc:sword; argv:PPdvoid;
  6131. envCallback:OCIEnvCallbackType):sword;cdecl;
  6132. OCIFileExists : function (hndl:Pdvoid; err:POCIError; filename:POraText; path:POraText; flag:Pub1):sword;cdecl;
  6133. OCIFileFlush : function (hndl:Pdvoid; err:POCIError; filep:POCIFileObject):sword;cdecl;
  6134. OCIFileGetLength : function (hndl:Pdvoid; err:POCIError; filename:POraText; path:POraText; lenp:Pubig_ora):sword;cdecl;
  6135. OCIFileInit : function (hndl:Pdvoid; err:POCIError):sword;cdecl;
  6136. OCIFileOpen : function (hndl:Pdvoid; err:POCIError; var filep:POCIFileObject; filename:POraText; path:POraText;
  6137. mode:ub4; create:ub4; _type:ub4):sword;cdecl;
  6138. OCIFileRead : function (hndl:Pdvoid; err:POCIError; filep:POCIFileObject; bufp:Pdvoid; bufl:ub4;
  6139. bytesread:Pub4):sword;cdecl;
  6140. OCIFileSeek : function (hndl:Pdvoid; err:POCIError; filep:POCIFileObject; origin:uword; offset:ubig_ora;
  6141. dir:sb1):sword;cdecl;
  6142. OCIFileTerm : function (hndl:Pdvoid; err:POCIError):sword;cdecl;
  6143. OCIFileWrite : function (hndl:Pdvoid; err:POCIError; filep:POCIFileObject; bufp:Pdvoid; buflen:ub4;
  6144. byteswritten:Pub4):sword;cdecl;
  6145. {$ifdef ORAXB8_DEFINED}
  6146. OCILobCopy2 : function (svchp:POCISvcCtx; errhp:POCIError; dst_locp:POCILobLocator; src_locp:POCILobLocator; amount:oraub8;
  6147. dst_offset:oraub8; src_offset:oraub8):sword;cdecl;
  6148. OCILobErase2 : function (svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; amount:Poraub8; offset:oraub8):sword;cdecl;
  6149. OCILobGetLength2 : function (svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; lenp:Poraub8):sword;cdecl;
  6150. OCILobLoadFromFile2 : function (svchp:POCISvcCtx; errhp:POCIError; dst_locp:POCILobLocator; src_filep:POCILobLocator; amount:oraub8;
  6151. dst_offset:oraub8; src_offset:oraub8):sword;cdecl;
  6152. OCILobRead2 : function (svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; byte_amtp:Poraub8; char_amtp:Poraub8;
  6153. offset:oraub8; bufp:Pdvoid; bufl:oraub8; piece:ub1; ctxp:Pdvoid;
  6154. cbfp:OCICallbackLobRead2; csid:ub2; csfrm:ub1):sword;cdecl;
  6155. OCILobArrayRead : function (svchp:POCISvcCtx; errhp:POCIError; array_iter:Pub4; lobp_arr:PPOCILobLocator; byte_amt_arr:Poraub8;
  6156. char_amt_arr:Poraub8; offset_arr:Poraub8; bufp_arr:PPdvoid; bufl_arr:Poraub8; piece:ub1;
  6157. ctxp:Pdvoid; cbfp:OCICallbackLobArrayRead; csid:ub2; csfrm:ub1):sword;cdecl;
  6158. OCILobTrim2 : function (svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; newlen:oraub8):sword;cdecl;
  6159. OCILobWrite2 : function (svchp:POCISvcCtx; errhp:POCIError; locp:POCILobLocator; byte_amtp:Poraub8; char_amtp:Poraub8;
  6160. offset:oraub8; bufp:Pdvoid; buflen:oraub8; piece:ub1; ctxp:Pdvoid;
  6161. cbfp:OCICallbackLobWrite2; csid:ub2; csfrm:ub1):sword;cdecl;
  6162. OCILobArrayWrite : function (svchp:POCISvcCtx; errhp:POCIError; array_iter:Pub4; lobp_arr:PPOCILobLocator; byte_amt_arr:Poraub8;
  6163. char_amt_arr:Poraub8; offset_arr:Poraub8; bufp_arr:PPdvoid; bufl_arr:Poraub8; piece:ub1;
  6164. ctxp:Pdvoid; cbfp:OCICallbackLobArrayWrite; csid:ub2; csfrm:ub1):sword;cdecl;
  6165. OCILobWriteAppend2 : function (svchp:POCISvcCtx; errhp:POCIError; lobp:POCILobLocator; byte_amtp:Poraub8; char_amtp:Poraub8;
  6166. bufp:Pdvoid; bufl:oraub8; piece:ub1; ctxp:Pdvoid; cbfp:OCICallbackLobWrite2;
  6167. csid:ub2; csfrm:ub1):sword;cdecl;
  6168. OCILobGetStorageLimit : function (svchp:POCISvcCtx; errhp:POCIError; lobp:POCILobLocator; limitp:Poraub8):sword;cdecl;
  6169. {$endif}
  6170. {
  6171. ** Initialize the security package
  6172. }
  6173. OCISecurityInitialize : function (sechandle:POCISecurity; error_handle:POCIError):sword;cdecl;
  6174. OCISecurityTerminate : function (sechandle:POCISecurity; error_handle:POCIError):sword;cdecl;
  6175. OCISecurityOpenWallet : function (osshandle:POCISecurity; error_handle:POCIError; wrllen:size_t; wallet_resource_locator:POraText; pwdlen:size_t;
  6176. password:POraText; wallet:PnzttWallet):sword;cdecl;
  6177. OCISecurityCloseWallet : function (osshandle:POCISecurity; error_handle:POCIError; wallet:PnzttWallet):sword;cdecl;
  6178. OCISecurityCreateWallet : function (osshandle:POCISecurity; error_handle:POCIError; wrllen:size_t; wallet_resource_locator:POraText; pwdlen:size_t;
  6179. password:POraText; wallet:PnzttWallet):sword;cdecl;
  6180. OCISecurityDestroyWallet : function (osshandle:POCISecurity; error_handle:POCIError; wrllen:size_t; wallet_resource_locator:POraText; pwdlen:size_t;
  6181. password:POraText):sword;cdecl;
  6182. OCISecurityStorePersona : function (osshandle:POCISecurity; error_handle:POCIError; var persona:PnzttPersona; wallet:PnzttWallet):sword;cdecl;
  6183. OCISecurityOpenPersona : function (osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona):sword;cdecl;
  6184. OCISecurityClosePersona : function (osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona):sword;cdecl;
  6185. OCISecurityRemovePersona : function (osshandle:POCISecurity; error_handle:POCIError; var persona:PnzttPersona):sword;cdecl;
  6186. OCISecurityCreatePersona : function (osshandle:POCISecurity; error_handle:POCIError; identity_type:nzttIdentType; cipher_type:nzttCipherType; desc:PnzttPersonaDesc;
  6187. var persona:PnzttPersona):sword;cdecl;
  6188. OCISecuritySetProtection : function (osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; crypto_engine_function:nzttcef; data_unit_format:nztttdufmt;
  6189. protection_info:PnzttProtInfo):sword;cdecl;
  6190. OCISecurityGetProtection : function (osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; crypto_engine_function:nzttcef; data_unit_format_ptr:Pnztttdufmt;
  6191. protection_info:PnzttProtInfo):sword;cdecl;
  6192. OCISecurityRemoveIdentity : function (osshandle:POCISecurity; error_handle:POCIError; var identity_ptr:PnzttIdentity):sword;cdecl;
  6193. OCISecurityCreateIdentity : function (osshandle:POCISecurity; error_handle:POCIError; _type:nzttIdentType; desc:PnzttIdentityDesc; var identity_ptr:PnzttIdentity):sword;cdecl;
  6194. OCISecurityAbortIdentity : function (osshandle:POCISecurity; error_handle:POCIError; var identity_ptr:PnzttIdentity):sword;cdecl;
  6195. OCISecurityFreeIdentity : function (osshandle:POCISecurity; error_handle:POCIError; var identity_ptr:PnzttIdentity):sword;cdecl;
  6196. OCISecurityStoreTrustedIdentity : function (osshandle:POCISecurity; error_handle:POCIError; var identity_ptr:PnzttIdentity; persona:PnzttPersona):sword;cdecl;
  6197. OCISecuritySign : function (osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; signature_state:nzttces; input_length:size_t;
  6198. input:Pub1; buffer_block:PnzttBufferBlock):sword;cdecl;
  6199. OCISecuritySignExpansion : function (osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; inputlen:size_t; signature_length:Psize_t):sword;cdecl;
  6200. OCISecurityVerify : function (osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; signature_state:nzttces; siglen:size_t;
  6201. signature:Pub1; extracted_message:PnzttBufferBlock; verified:Pboolean; validated:Pboolean; var signing_party_identity:PnzttIdentity):sword;cdecl;
  6202. OCISecurityValidate : function (osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; identity:PnzttIdentity; validated:Pboolean):sword;cdecl;
  6203. OCISecuritySignDetached : function (osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; signature_state:nzttces; input_length:size_t;
  6204. input:Pub1; signature:PnzttBufferBlock):sword;cdecl;
  6205. OCISecuritySignDetExpansion : function (osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; input_length:size_t; required_buffer_length:Psize_t):sword;cdecl;
  6206. OCISecurityVerifyDetached : function (osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; signature_state:nzttces; data_length:size_t;
  6207. data:Pub1; siglen:size_t; signature:Pub1; verified:Pboolean; validated:Pboolean;
  6208. var signing_party_identity:PnzttIdentity):sword;cdecl;
  6209. OCISecurity_PKEncrypt : function (osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; number_of_recipients:size_t; recipient_list:PnzttIdentity;
  6210. encryption_state:nzttces; input_length:size_t; input:Pub1; encrypted_data:PnzttBufferBlock):sword;cdecl;
  6211. OCISecurityPKEncryptExpansion : function (osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; number_recipients:size_t; input_length:size_t;
  6212. buffer_length_required:Psize_t):sword;cdecl;
  6213. OCISecurityPKDecrypt : function (osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; encryption_state:nzttces; input_length:size_t;
  6214. input:Pub1; encrypted_data:PnzttBufferBlock):sword;cdecl;
  6215. OCISecurityEncrypt : function (osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; encryption_state:nzttces; input_length:size_t;
  6216. input:Pub1; encrypted_data:PnzttBufferBlock):sword;cdecl;
  6217. OCISecurityEncryptExpansion : function (osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; input_length:size_t; encrypted_data_length:Psize_t):sword;cdecl;
  6218. OCISecurityDecrypt : function (osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; decryption_state:nzttces; input_length:size_t;
  6219. input:Pub1; decrypted_data:PnzttBufferBlock):sword;cdecl;
  6220. OCISecurityEnvelope : function (osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; number_of_recipients:size_t; identity:PnzttIdentity;
  6221. encryption_state:nzttces; input_length:size_t; input:Pub1; enveloped_data:PnzttBufferBlock):sword;cdecl;
  6222. OCISecurityDeEnvelope : function (osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; decryption_state:nzttces; input_length:size_t;
  6223. input:Pub1; output_message:PnzttBufferBlock; verified:Pboolean; validated:Pboolean; var sender_identity:PnzttIdentity):sword;cdecl;
  6224. OCISecurityKeyedHash : function (osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; hash_state:nzttces; input_length:size_t;
  6225. input:Pub1; keyed_hash:PnzttBufferBlock):sword;cdecl;
  6226. OCISecurityKeyedHashExpansion : function (osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; input_length:size_t; required_buffer_length:Psize_t):sword;cdecl;
  6227. OCISecurityHash : function (osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; hash_state:nzttces; input:size_t;
  6228. input_length:Pub1; hash:PnzttBufferBlock):sword;cdecl;
  6229. OCISecurityHashExpansion : function (osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; input_length:size_t; required_buffer_length:Psize_t):sword;cdecl;
  6230. OCISecuritySeedRandom : function (osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; seed_length:size_t; seed:Pub1):sword;cdecl;
  6231. OCISecurityRandomBytes : function (osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; number_of_bytes_desired:size_t; random_bytes:PnzttBufferBlock):sword;cdecl;
  6232. OCISecurityRandomNumber : function (osshandle:POCISecurity; error_handle:POCIError; persona:PnzttPersona; random_number_ptr:Puword):sword;cdecl;
  6233. OCISecurityInitBlock : function (osshandle:POCISecurity; error_handle:POCIError; buffer_block:PnzttBufferBlock):sword;cdecl;
  6234. OCISecurityReuseBlock : function (osshandle:POCISecurity; error_handle:POCIError; buffer_block:PnzttBufferBlock):sword;cdecl;
  6235. OCISecurityPurgeBlock : function (osshandle:POCISecurity; error_handle:POCIError; buffer_block:PnzttBufferBlock):sword;cdecl;
  6236. OCISecuritySetBlock : function (osshandle:POCISecurity; error_handle:POCIError; flags_to_set:uword; buffer_length:size_t; used_buffer_length:size_t;
  6237. buffer:Pub1; buffer_block:PnzttBufferBlock):sword;cdecl;
  6238. OCISecurityGetIdentity : function (osshandle:POCISecurity; error_handle:POCIError; namelen:size_t; distinguished_name:POraText; var identity:PnzttIdentity):sword;cdecl;
  6239. OCIAQEnq : function (svchp:POCISvcCtx; errhp:POCIError; queue_name:POraText; enqopt:POCIAQEnqOptions; msgprop:POCIAQMsgProperties;
  6240. payload_tdo:POCIType; payload:PPdvoid; payload_ind:PPdvoid; var msgid:POCIRaw; flags:ub4):sword;cdecl;
  6241. OCIAQDeq : function (svchp:POCISvcCtx; errhp:POCIError; queue_name:POraText; deqopt:POCIAQDeqOptions; msgprop:POCIAQMsgProperties;
  6242. payload_tdo:POCIType; payload:PPdvoid; payload_ind:PPdvoid; var msgid: POCIRaw; flags:ub4):sword;cdecl;
  6243. OCIAQEnqArray : function (svchp:POCISvcCtx; errhp:POCIError; queue_name:POraText; enqopt:POCIAQEnqOptions; iters:Pub4;
  6244. var msgprop:POCIAQMsgProperties; payload_tdo:POCIType; payload:PPdvoid; payload_ind:PPdvoid; var msgid:POCIRaw;
  6245. ctxp:Pdvoid; enqcbfp:OCICallbackAQEnq; flags:ub4):sword;cdecl;
  6246. OCIAQDeqArray : function (svchp:POCISvcCtx; errhp:POCIError; queue_name:POraText; deqopt:POCIAQDeqOptions; iters:Pub4;
  6247. var msgprop:POCIAQMsgProperties; payload_tdo:POCIType; payload:PPdvoid; payload_ind:PPdvoid; var msgid:POCIRaw;
  6248. ctxp:Pdvoid; deqcbfp:OCICallbackAQDeq; flags:ub4):sword;cdecl;
  6249. OCIAQListen : function (svchp:POCISvcCtx; errhp:POCIError; var agent_list:POCIAQAgent; num_agents:ub4; wait:sb4;
  6250. var agent:POCIAQAgent; flags:ub4):sword;cdecl;
  6251. OCIAQListen2 : function (svchp:POCISvcCtx; errhp:POCIError; var agent_list:POCIAQAgent; num_agents:ub4; lopts:POCIAQListenOpts;
  6252. var agent:POCIAQAgent; lmops:POCIAQLisMsgProps; flags:ub4):sword;cdecl;
  6253. OCIExtractInit : function (hndl:Pdvoid; err:POCIError):sword;cdecl;
  6254. OCIExtractTerm : function (hndl:Pdvoid; err:POCIError):sword;cdecl;
  6255. OCIExtractReset : function (hndl:Pdvoid; err:POCIError):sword;cdecl;
  6256. OCIExtractSetNumKeys : function (hndl:Pdvoid; err:POCIError; numkeys:uword):sword;cdecl;
  6257. OCIExtractSetKey : function (hndl:Pdvoid; err:POCIError; name:POraText; _type:ub1; flag:ub4;
  6258. defval:Pdvoid; intrange:Psb4; var strlist:POraText):sword;cdecl;
  6259. OCIExtractFromFile : function (hndl:Pdvoid; err:POCIError; flag:ub4; filename:POraText):sword;cdecl;
  6260. OCIExtractFromStr : function (hndl:Pdvoid; err:POCIError; flag:ub4; input:POraText):sword;cdecl;
  6261. OCIExtractToInt : function (hndl:Pdvoid; err:POCIError; keyname:POraText; valno:uword; retval:Psb4):sword;cdecl;
  6262. OCIExtractToBool : function (hndl:Pdvoid; err:POCIError; keyname:POraText; valno:uword; retval:Pub1):sword;cdecl;
  6263. OCIExtractToStr : function (hndl:Pdvoid; err:POCIError; keyname:POraText; valno:uword; retval:POraText;
  6264. buflen:uword):sword;cdecl;
  6265. OCIExtractToOCINum : function (hndl:Pdvoid; err:POCIError; keyname:POraText; valno:uword; retval:POCINumber):sword;cdecl;
  6266. OCIExtractToList : function (hndl:Pdvoid; err:POCIError; numkeys:Puword):sword;cdecl;
  6267. OCIExtractFromList : function (hndl:Pdvoid; err:POCIError; index:uword; var name:POraText; _type:Pub1;
  6268. numvals:Puword; values:PPPdvoid):sword;cdecl;
  6269. { Memory Related Service Interfaces }
  6270. OCIMemoryAlloc : function (hdl:Pdvoid; err:POCIError; mem:PPdvoid; dur:OCIDuration; size:ub4;
  6271. flags:ub4):sword;cdecl;
  6272. OCIMemoryResize : function (hdl:Pdvoid; err:POCIError; mem:PPdvoid; newsize:ub4; flags:ub4):sword;cdecl;
  6273. OCIMemoryFree : function (hdl:Pdvoid; err:POCIError; mem:Pdvoid):sword;cdecl;
  6274. OCIContextSetValue : function (hdl:Pdvoid; err:POCIError; duration:OCIDuration; key:Pub1; keylen:ub1;
  6275. ctx_value:Pdvoid):sword;cdecl;
  6276. OCIContextGetValue : function (hdl:Pdvoid; err:POCIError; key:Pub1; keylen:ub1; ctx_value:PPdvoid):sword;cdecl;
  6277. OCIContextClearValue : function (hdl:Pdvoid; err:POCIError; key:Pub1; keylen:ub1):sword;cdecl;
  6278. OCIContextGenerateKey : function (hdl:Pdvoid; err:POCIError; key:Pub4):sword;cdecl;
  6279. OCIMemorySetCurrentIDs : function (hdl:Pdvoid; err:POCIError; curr_session_id:ub4; curr_trans_id:ub4; curr_stmt_id:ub4):sword;cdecl;
  6280. OCIPicklerTdsCtxInit : function (env:POCIEnv; err:POCIError; var tdsc:POCIPicklerTdsCtx):sword;cdecl;
  6281. OCIPicklerTdsCtxFree : function (env:POCIEnv; err:POCIError; tdsc:POCIPicklerTdsCtx):sword;cdecl;
  6282. OCIPicklerTdsInit : function (env:POCIEnv; err:POCIError; tdsc:POCIPicklerTdsCtx; var tdsh:POCIPicklerTds):sword;cdecl;
  6283. OCIPicklerTdsFree : function (env:POCIEnv; err:POCIError; tdsh:POCIPicklerTds):sword;cdecl;
  6284. OCIPicklerTdsCreateElementNumber : function (env:POCIEnv; err:POCIError; tdsh:POCIPicklerTds; prec:ub1; scale:sb1;
  6285. elt:POCIPicklerTdsElement):sword;cdecl;
  6286. OCIPicklerTdsCreateElementChar : function (env:POCIEnv; err:POCIError; tdsh:POCIPicklerTds; len:ub2; elt:POCIPicklerTdsElement):sword;cdecl;
  6287. OCIPicklerTdsCreateElementVarchar : function (env:POCIEnv; err:POCIError; tdsh:POCIPicklerTds; len:ub2; elt:POCIPicklerTdsElement):sword;cdecl;
  6288. OCIPicklerTdsCreateElementRaw : function (env:POCIEnv; err:POCIError; tdsh:POCIPicklerTds; len:ub2; elt:POCIPicklerTdsElement):sword;cdecl;
  6289. OCIPicklerTdsCreateElement : function (env:POCIEnv; err:POCIError; tdsh:POCIPicklerTds; dty:OCITypeCode; elt:POCIPicklerTdsElement):sword;cdecl;
  6290. OCIPicklerTdsAddAttr : function (env:POCIEnv; err:POCIError; tdsh:POCIPicklerTds; elt:OCIPicklerTdsElement):sword;cdecl;
  6291. OCIPicklerTdsGenerate : function (env:POCIEnv; err:POCIError; tdsh:POCIPicklerTds):sword;cdecl;
  6292. OCIPicklerTdsGetAttr : function (env:POCIEnv; err:POCIError; tdsh:POCIPicklerTds; attrno:ub1; typ:POCITypeCode;
  6293. len:Pub2):sword;cdecl;
  6294. OCIPicklerFdoInit : function (env:POCIEnv; err:POCIError; var fdoh:POCIPicklerFdo):sword;cdecl;
  6295. OCIPicklerFdoFree : function (env:POCIEnv; err:POCIError; fdoh:POCIPicklerFdo):sword;cdecl;
  6296. OCIPicklerImageInit : function (env:POCIEnv; err:POCIError; fdoh:POCIPicklerFdo; tdsh:POCIPicklerTds; var imgh:POCIPicklerImage):sword;cdecl;
  6297. OCIPicklerImageFree : function (env:POCIEnv; err:POCIError; imgh:POCIPicklerImage):sword;cdecl;
  6298. OCIPicklerImageAddScalar : function (env:POCIEnv; err:POCIError; imgh:POCIPicklerImage; scalar:Pdvoid; len:ub4):sword;cdecl;
  6299. OCIPicklerImageAddNullScalar : function (env:POCIEnv; err:POCIError; imgh:POCIPicklerImage):sword;cdecl;
  6300. OCIPicklerImageGenerate : function (env:POCIEnv; err:POCIError; imgh:POCIPicklerImage):sword;cdecl;
  6301. OCIPicklerImageGetScalarSize : function (env:POCIEnv; err:POCIError; imgh:POCIPicklerImage; attrno:ub4; size:Pub4):sword;cdecl;
  6302. OCIPicklerImageGetScalar : function (env:POCIEnv; err:POCIError; imgh:POCIPicklerImage; attrno:ub4; buf:Pdvoid;
  6303. len:Pub4; ind:POCIInd):sword;cdecl;
  6304. OCIPicklerImageCollBegin : function (env:POCIEnv; err:POCIError; imgh:POCIPicklerImage; colltdsh:POCIPicklerTds):sword;cdecl;
  6305. OCIPicklerImageCollAddScalar : function (env:POCIEnv; err:POCIError; imgh:POCIPicklerImage; scalar:Pdvoid; buflen:ub4;
  6306. ind:OCIInd):sword;cdecl;
  6307. OCIPicklerImageCollEnd : function (env:POCIEnv; err:POCIError; imgh:POCIPicklerImage):sword;cdecl;
  6308. { should take svcctx for locator stuff }
  6309. OCIPicklerImageCollBeginScan : function (env:POCIEnv; err:POCIError; imgh:POCIPicklerImage; coll_tdsh:POCIPicklerTds; attrnum:ub4;
  6310. startidx:ub4; ind:POCIInd):sword;cdecl;
  6311. OCIPicklerImageCollGetScalarSize : function (env:POCIEnv; err:POCIError; coll_tdsh:POCIPicklerTds; size:Pub4):sword;cdecl;
  6312. OCIPicklerImageCollGetScalar : function (env:POCIEnv; err:POCIError; imgh:POCIPicklerImage; buf:Pdvoid; buflen:Pub4;
  6313. ind:POCIInd):sword;cdecl;
  6314. OCIAnyDataGetType : function (svchp:POCISvcCtx; errhp:POCIError; sdata:POCIAnyData; tc:POCITypeCode; var _type:POCIType):sword;cdecl;
  6315. OCIAnyDataIsNull : function (svchp:POCISvcCtx; errhp:POCIError; sdata:POCIAnyData; isnull:Pboolean):sword;cdecl;
  6316. OCIAnyDataConvert : function (svchp:POCISvcCtx; errhp:POCIError; tc:OCITypeCode; _type:POCIType; dur:OCIDuration;
  6317. ind:Pdvoid; data_val:Pdvoid; len:ub4; var sdata:POCIAnyData):sword;cdecl;
  6318. OCIAnyDataBeginCreate : function (svchp:POCISvcCtx; errhp:POCIError; tc:OCITypeCode; _type:POCIType; dur:OCIDuration;
  6319. var sdata:POCIAnyData):sword;cdecl;
  6320. OCIAnyDataDestroy : function (svchp:POCISvcCtx; errhp:POCIError; sdata:POCIAnyData):sword;cdecl;
  6321. OCIAnyDataAttrSet : function (svchp:POCISvcCtx; errhp:POCIError; sdata:POCIAnyData; tc:OCITypeCode; _type:POCIType;
  6322. ind:Pdvoid; attr_val:Pdvoid; length:ub4; is_any:boolean):sword;cdecl;
  6323. OCIAnyDataCollAddElem : function (svchp:POCISvcCtx; errhp:POCIError; sdata:POCIAnyData; tc:OCITypeCode; _type:POCIType;
  6324. ind:Pdvoid; attr_val:Pdvoid; length:ub4; is_any:boolean; last_elem:boolean):sword;cdecl;
  6325. OCIAnyDataEndCreate : function (svchp:POCISvcCtx; errhp:POCIError; sdata:POCIAnyData):sword;cdecl;
  6326. OCIAnyDataAccess : function (svchp:POCISvcCtx; errhp:POCIError; sdata:POCIAnyData; tc:OCITypeCode; _type:POCIType;
  6327. ind:Pdvoid; attr_val:Pdvoid; length:Pub4):sword;cdecl;
  6328. OCIAnyDataGetCurrAttrNum : function (svchp:POCISvcCtx; errhp:POCIError; sdata:POCIAnyData; attrnum:Pub4):sword;cdecl;
  6329. OCIAnyDataAttrGet : function (svchp:POCISvcCtx; errhp:POCIError; sdata:POCIAnyData; tc:OCITypeCode; _type:POCIType;
  6330. ind:Pdvoid; attr_val:Pdvoid; length:Pub4; is_any:boolean):sword;cdecl;
  6331. OCIAnyDataCollGetElem : function (svchp:POCISvcCtx; errhp:POCIError; sdata:POCIAnyData; tc:OCITypeCode; _type:POCIType;
  6332. ind:Pdvoid; celem_val:Pdvoid; length:Pub4; is_any:boolean):sword;cdecl;
  6333. {$ENDIF}
  6334. {------------------------ OCIAnyDataSet interfaces ------------------------- }
  6335. {
  6336. NAME
  6337. OCIAnyDataSetBeginCreate - OCIAnyDataSet Begin Creation
  6338. PARAMETERS
  6339. svchp (IN/OUT) - The OCI service context.
  6340. errhp (IN/OUT) - The OCI error handle. If there is an error, it is
  6341. recorded in errhp and this function returns OCI_ERROR.
  6342. Diagnostic information can be obtained by calling
  6343. OCIErrorGet().
  6344. typecode - typecode corresponding to the OCIAnyDataSet.
  6345. type (IN) - type corresponding to the OCIAnyDataSet. If the typecode
  6346. corresponds to a built-in type (OCI_TYPECODE_NUMBER etc.)
  6347. , this parameter can be NULL. It should be non NULL for
  6348. user defined types (OCI_TYPECODE_OBJECT,
  6349. OCI_TYPECODE_REF, collection types etc.)
  6350. dur (IN) - duration for which OCIAnyDataSet is allocated.
  6351. data_set (OUT) - Initialized OCIAnyDataSet.
  6352. RETURNS - error code
  6353. NOTES
  6354. This call allocates an OCIAnyDataSet for the duration of dur and
  6355. initializes it with the type information. The OCIAnyDataSet can hold
  6356. multiple instances of the given type. For performance reasons, the
  6357. OCIAnyDataSet will end up pointing to the passed in OCIType parameter.
  6358. It is the responsibility of the caller to ensure that the OCIType is
  6359. longer lived (has allocation duration >= the duration of the OCIAnyData
  6360. if the OCIType is a transient one, allocation/pin duration >= duration of
  6361. the OCIAnyData if the OCIType is a persistent one).
  6362. }
  6363. {$IFNDEF LinkDynamically}
  6364. function OCIAnyDataSetBeginCreate(svchp:POCISvcCtx; errhp:POCIError; typecode:OCITypeCode; _type:POCIType; dur:OCIDuration;
  6365. var data_set:POCIAnyDataSet):sword;cdecl;external ocilib name 'OCIAnyDataSetBeginCreate';
  6366. {$ELSE}
  6367. OCIAnyDataSetBeginCreate : function (svchp:POCISvcCtx; errhp:POCIError; typecode:OCITypeCode; _type:POCIType; dur:OCIDuration;
  6368. var data_set:POCIAnyDataSet):sword;cdecl;
  6369. {$ENDIF}
  6370. {
  6371. NAME
  6372. OCIAnyDataSetDestroy - OCIAnyDataSet Destroy
  6373. DESCRIPTION
  6374. This call frees the OCIAnyDataSet allocated using
  6375. OCIAnyDataSetBeginCreate().
  6376. RETURNS
  6377. error code.
  6378. PARAMETERS
  6379. svchp (IN/OUT) - The OCI service context.
  6380. errhp (IN/OUT) - The OCI Error handle.
  6381. data_set (IN/OUT) - OCIAnyDataSet to be freed.
  6382. }
  6383. {$IFNDEF LinkDynamically}
  6384. function OCIAnyDataSetDestroy(svchp:POCISvcCtx; errhp:POCIError; data_set:POCIAnyDataSet):sword;cdecl;external ocilib name 'OCIAnyDataSetDestroy';
  6385. {$ELSE}
  6386. OCIAnyDataSetDestroy : function (svchp:POCISvcCtx; errhp:POCIError; data_set:POCIAnyDataSet):sword;cdecl;
  6387. {$ENDIF}
  6388. {
  6389. NAME
  6390. OCIAnyDataSetAddInstance - OCIAnyDataSet Add an instance
  6391. DESCRIPTION
  6392. This call adds a new skeleton instance to the OCIAnyDataSet and all the
  6393. attributes of the instance are set to NULL. It returns this skeleton
  6394. instance through the OCIAnyData parameter which can be constructed
  6395. subsequently by invoking the OCIAnyData API.
  6396. RETURNS
  6397. error code.
  6398. PARAMETERS
  6399. svchp (IN/OUT) - The OCI service context.
  6400. errhp (IN/OUT) - The OCI Error handle.
  6401. data_set (IN/OUT) - OCIAnyDataSet to which a new instance is added.
  6402. data (IN/OUT) - OCIAnyData corresponding to the newly added
  6403. instance. If (*data) is NULL, a new OCIAnyData will
  6404. be allocated for same duration as the OCIAnyDataSet.
  6405. If (*data) is not NULL, it will get reused. This
  6406. OCIAnyData can be subseqently constructed using the
  6407. OCIAnyDataConvert() call or it can be constructed
  6408. piece-wise using the OCIAnyDataAttrSet and
  6409. OCIAnyDataCollAddElem calls.
  6410. NOTES
  6411. No Destruction of the old value is done here. It is the responsibility of
  6412. the caller to destroy the old value pointed to by (*data) and set (*data)
  6413. to a null pointer before beginning to make a sequence of this call. No
  6414. deep copying (of OCIType information nor the data part.) is done in the
  6415. returned OCIAnyData. This OCIAnyData cannot be used beyond the allocation
  6416. duration of the OCIAnyDataSet (it is like a reference into the
  6417. OCIAnyDataSet). The returned OCIAnyData can be reused on subsequent calls
  6418. to this function, to sequentially add new data instances to the
  6419. OCIAnyDataSet.
  6420. }
  6421. {$IFNDEF LinkDynamically}
  6422. function OCIAnyDataSetAddInstance(svchp:POCISvcCtx; errhp:POCIError; data_set:POCIAnyDataSet; var data:POCIAnyData):sword;cdecl;external ocilib name 'OCIAnyDataSetAddInstance';
  6423. {$ELSE}
  6424. OCIAnyDataSetAddInstance : function (svchp:POCISvcCtx; errhp:POCIError; data_set:POCIAnyDataSet; var data:POCIAnyData):sword;cdecl;
  6425. {$ENDIF}
  6426. {
  6427. NAME
  6428. OCIAnyDataSetEndCreate - OCIAnyDataSet End Creation process.
  6429. DESCRIPTION
  6430. This call marks the end of OCIAnyDataSet creation. It should be called
  6431. after constructing all of its instance(s).
  6432. RETURNS
  6433. error code.
  6434. PARAMETERS
  6435. svchp (IN/OUT) - The OCI service context.
  6436. errhp (IN/OUT) - The OCI error handle. If there is an error, it is
  6437. recorded in errhp and this function returns
  6438. OCI_ERROR. Diagnostic information can be obtained
  6439. by calling OCIErrorGet().
  6440. data_set (IN/OUT) - OCIAnyDataSet that has been fully constructed.
  6441. }
  6442. {$IFNDEF LinkDynamically}
  6443. function OCIAnyDataSetEndCreate(svchp:POCISvcCtx; errhp:POCIError; data_set:POCIAnyDataSet):sword;cdecl;external ocilib name 'OCIAnyDataSetEndCreate';
  6444. {$ELSE}
  6445. OCIAnyDataSetEndCreate : function (svchp:POCISvcCtx; errhp:POCIError; data_set:POCIAnyDataSet):sword;cdecl;
  6446. {$ENDIF}
  6447. {
  6448. NAME
  6449. OCIAnyDataSetGetType - OCIAnyDataSet Get Type of an OCIAnyDataSet
  6450. DESCRIPTION
  6451. Gets the Type corresponding to an OCIAnyDataSet. It returns the actual
  6452. pointer to the type maintained inside an OCIAnyDataSet. No copying is
  6453. done for performance reasons. The client is responsible for not using
  6454. this type once the OCIAnyDataSet is freed (or its duration ends).
  6455. RETURNS
  6456. error code.
  6457. PARAMETERS
  6458. svchp (IN/OUT) - The OCI service context.
  6459. errhp (IN/OUT) - The OCI Error handle.
  6460. data_set (IN) - Initialized OCIAnyDataSet.
  6461. tc (OUT) - The typecode of the type.
  6462. type (OUT) - The type corresponding to the OCIAnyDataSet. This
  6463. could be null if the OCIAnyData corresponds to a
  6464. built-in type.
  6465. }
  6466. {$IFNDEF LinkDynamically}
  6467. function OCIAnyDataSetGetType(svchp:POCISvcCtx; errhp:POCIError; data_set:POCIAnyDataSet; tc:POCITypeCode; var _type:POCIType):sword;cdecl;external ocilib name 'OCIAnyDataSetGetType';
  6468. {$ELSE}
  6469. OCIAnyDataSetGetType : function (svchp:POCISvcCtx; errhp:POCIError; data_set:POCIAnyDataSet; tc:POCITypeCode; var _type:POCIType):sword;cdecl;
  6470. {$ENDIF}
  6471. {
  6472. NAME
  6473. OCIAnyDataSetGetCount - OCIAnyDataSet Get Count of instances.
  6474. DESCRIPTION
  6475. This call gets the number of instances in the OCIAnyDataSet.
  6476. RETURNS
  6477. error code.
  6478. PARAMETERS
  6479. svchp (IN/OUT) - OCI Service Context
  6480. errhp (IN/OUT) - OCI Error handle
  6481. data_set (IN) - Well formed OCIAnyDataSet.
  6482. count (OUT) - number of instances in OCIAnyDataSet
  6483. }
  6484. {$IFNDEF LinkDynamically}
  6485. function OCIAnyDataSetGetCount(svchp:POCISvcCtx; errhp:POCIError; data_set:POCIAnyDataSet; count:Pub4):sword;cdecl;external ocilib name 'OCIAnyDataSetGetCount';
  6486. {$ELSE}
  6487. OCIAnyDataSetGetCount : function (svchp:POCISvcCtx; errhp:POCIError; data_set:POCIAnyDataSet; count:Pub4):sword;cdecl;
  6488. {$ENDIF}
  6489. {
  6490. NAME
  6491. OCIAnyDataSetGetInstance - OCIAnyDataSet Get next instance.
  6492. DESCRIPTION
  6493. Only sequential access to the instances in an OCIAnyDataSet is allowed.
  6494. This call returns the OCIAnyData corresponding to an instance at the
  6495. current position and updates the current position. Subsequently, the
  6496. OCIAnyData access routines may be used to access the instance.
  6497. RETURNS
  6498. error code. Returns OCI_NO_DATA if the current position is at the end of
  6499. the set, OCI_SUCCESS otherwise.
  6500. PARAMETERS
  6501. svchp (IN/OUT) - OCI Service Context
  6502. errhp (IN/OUT) - OCI Error handle
  6503. data_set (IN) - Well formed OCIAnyDataSet
  6504. data (IN/OUT) - OCIAnyData corresponding to the instance. If (*data)
  6505. is NULL, a new OCIAnyData will be allocated for same
  6506. duration as the OCIAnyDataSet. If (*data) is not NULL
  6507. , it will get reused. This OCIAnyData can be
  6508. subsequently accessed using the OCIAnyDataAccess()
  6509. call or piece-wise by using the OCIAnyDataAttrGet()
  6510. call.
  6511. NOTE
  6512. No Destruction of the old value is done here. It is the responsibility of
  6513. the caller to destroy the old value pointed to by (*data) and set (*data)
  6514. to a null pointer before beginning to make a sequence of this call. No deep
  6515. copying (of OCIType information nor the data part.) is done in the returned
  6516. OCIAnyData. This OCIAnyData cannot be used beyond the allocation duration
  6517. of the OCIAnyDataSet (it is like a reference into the OCIAnyDataSet). The
  6518. returned OCIAnyData can be reused on subsequent calls to this function to
  6519. sequentially access the OCIAnyDataSet.
  6520. }
  6521. {$IFNDEF LinkDynamically}
  6522. function OCIAnyDataSetGetInstance(svchp:POCISvcCtx; errhp:POCIError; data_set:POCIAnyDataSet; var data:POCIAnyData):sword;cdecl;external ocilib name 'OCIAnyDataSetGetInstance';
  6523. {$ELSE}
  6524. OCIAnyDataSetGetInstance : function (svchp:POCISvcCtx; errhp:POCIError; data_set:POCIAnyDataSet; var data:POCIAnyData):sword;cdecl;
  6525. {$ENDIF}
  6526. {--------------------- End of OCIAnyDataSet interfaces --------------------- }
  6527. {$IFNDEF LinkDynamically}
  6528. function OCIFormatInit(hndl:Pdvoid; err:POCIError):sword;cdecl;external ocilib name 'OCIFormatInit';
  6529. // function OCIFormatString(hndl:Pdvoid; err:POCIError; buffer:POraText; bufferLength:sbig_ora; returnLength:Psbig_ora;
  6530. // formatString:POraText; args:array of const):sword;cdecl;external ocilib name 'OCIFormatString';
  6531. function OCIFormatString(hndl:Pdvoid; err:POCIError; buffer:POraText; bufferLength:sbig_ora; returnLength:Psbig_ora;
  6532. formatString:POraText):sword;cdecl;external ocilib name 'OCIFormatString';
  6533. function OCIFormatTerm(hndl:Pdvoid; err:POCIError):sword;cdecl;external ocilib name 'OCIFormatTerm';
  6534. function OCIFormatTUb1:sword;cdecl;external ocilib name 'OCIFormatTUb1';
  6535. function OCIFormatTUb2:sword;cdecl;external ocilib name 'OCIFormatTUb2';
  6536. function OCIFormatTUb4:sword;cdecl;external ocilib name 'OCIFormatTUb4';
  6537. function OCIFormatTUword:sword;cdecl;external ocilib name 'OCIFormatTUword';
  6538. function OCIFormatTUbig_ora:sword;cdecl;external ocilib name 'OCIFormatTUbig_ora';
  6539. function OCIFormatTSb1:sword;cdecl;external ocilib name 'OCIFormatTSb1';
  6540. function OCIFormatTSb2:sword;cdecl;external ocilib name 'OCIFormatTSb2';
  6541. function OCIFormatTSb4:sword;cdecl;external ocilib name 'OCIFormatTSb4';
  6542. function OCIFormatTSword:sword;cdecl;external ocilib name 'OCIFormatTSword';
  6543. function OCIFormatTSbig_ora:sword;cdecl;external ocilib name 'OCIFormatTSbig_ora';
  6544. function OCIFormatTEb1:sword;cdecl;external ocilib name 'OCIFormatTEb1';
  6545. function OCIFormatTEb2:sword;cdecl;external ocilib name 'OCIFormatTEb2';
  6546. function OCIFormatTEb4:sword;cdecl;external ocilib name 'OCIFormatTEb4';
  6547. function OCIFormatTEword:sword;cdecl;external ocilib name 'OCIFormatTEword';
  6548. function OCIFormatTChar:sword;cdecl;external ocilib name 'OCIFormatTChar';
  6549. function OCIFormatTText:sword;cdecl;external ocilib name 'OCIFormatTText';
  6550. function OCIFormatTDouble:sword;cdecl;external ocilib name 'OCIFormatTDouble';
  6551. function OCIFormatTDvoid:sword;cdecl;external ocilib name 'OCIFormatTDvoid';
  6552. function OCIFormatTEnd:sword;cdecl;external ocilib name 'OCIFormatTEnd';
  6553. {$ELSE}
  6554. OCIFormatInit : function (hndl:Pdvoid; err:POCIError):sword;cdecl;
  6555. // function OCIFormatString(hndl:Pdvoid; err:POCIError; buffer:POraText; bufferLength:sbig_ora; returnLength:Psbig_ora;
  6556. // formatString:POraText; args:array of const):sword;cdecl;external ocilib name 'OCIFormatString';
  6557. OCIFormatString : function (hndl:Pdvoid; err:POCIError; buffer:POraText; bufferLength:sbig_ora; returnLength:Psbig_ora;
  6558. formatString:POraText):sword;cdecl;
  6559. OCIFormatTerm : function (hndl:Pdvoid; err:POCIError):sword;cdecl;
  6560. OCIFormatTUb1: function : sword;cdecl;
  6561. OCIFormatTUb2: function : sword;cdecl;
  6562. OCIFormatTUb4: function :sword;cdecl;
  6563. OCIFormatTUword: function :sword;cdecl;
  6564. OCIFormatTUbig_ora: function :sword;cdecl;
  6565. OCIFormatTSb1: function :sword;cdecl;
  6566. OCIFormatTSb2: function :sword;cdecl;
  6567. OCIFormatTSb4: function :sword;cdecl;
  6568. OCIFormatTSword: function :sword;cdecl;
  6569. OCIFormatTSbig_ora: function :sword;cdecl;
  6570. OCIFormatTEb1: function :sword;cdecl;
  6571. OCIFormatTEb2: function :sword;cdecl;
  6572. OCIFormatTEb4: function :sword;cdecl;
  6573. OCIFormatTEword: function :sword;cdecl;
  6574. OCIFormatTChar: function :sword;cdecl;
  6575. OCIFormatTText: function :sword;cdecl;
  6576. OCIFormatTDouble: function :sword;cdecl;
  6577. OCIFormatTDvoid: function :sword;cdecl;
  6578. OCIFormatTEnd: function :sword;cdecl;
  6579. {$ENDIF}
  6580. {-------------------------- Extensions to XA interface --------------------- }
  6581. { ------------------------- xaosvch ---------------------------------------- }
  6582. {
  6583. NAME
  6584. xaosvch - XA Oracle get SerViCe Handle
  6585. DESCRIPTION
  6586. Given a database name return the service handle that is used by the
  6587. XA library
  6588. NOTE
  6589. This macro has been provided for backward compatibilty with 8.0.2
  6590. }
  6591. {$IFNDEF LinkDynamically}
  6592. function xaosvch(dbname:POraText):POCISvcCtx;cdecl;external ocilib name 'xaosvch';
  6593. {$ELSE}
  6594. xaosvch : function (dbname:POraText):POCISvcCtx;cdecl;
  6595. {$ENDIF}
  6596. { ------------------------- xaoSvcCtx -------------------------------------- }
  6597. {
  6598. NAME
  6599. xaoSvcCtx - XA Oracle get SerViCe ConTeXt
  6600. DESCRIPTION
  6601. Given a database name return the service handle that is used by the
  6602. XA library
  6603. NOTE
  6604. This routine has been provided for APs to get access to the service
  6605. handle that XA library uses. Without this routine APs must use SQLLIB
  6606. routine sqlld2 to get access to the Logon data area registered by the
  6607. XA library
  6608. }
  6609. {$IFNDEF LinkDynamically}
  6610. function xaoSvcCtx(dbname:POraText):POCISvcCtx;cdecl;external ocilib name 'xaoSvcCtx';
  6611. {$ELSE}
  6612. xaoSvcCtx : function (dbname:POraText):POCISvcCtx;cdecl;
  6613. {$ENDIF}
  6614. { ------------------------- xaoEnv ----------------------------------------- }
  6615. {
  6616. NAME
  6617. xaoEnv - XA Oracle get ENvironment Handle
  6618. DESCRIPTION
  6619. Given a database name return the environment handle that is used by the
  6620. XA library
  6621. NOTE
  6622. This routine has been provided for APs to get access to the environment
  6623. handle that XA library uses. Without this routine APs must use SQLLIB
  6624. routine sqlld2 to get access to the Logon data area registered by the
  6625. XA library
  6626. }
  6627. {$IFNDEF LinkDynamically}
  6628. function xaoEnv(dbname:POraText):POCIEnv;cdecl;external ocilib name 'xaoEnv';
  6629. {$ELSE}
  6630. xaoEnv : function (dbname:POraText):POCIEnv;cdecl;
  6631. {$ENDIF}
  6632. { ------------------------- xaosterr --------------------------------------- }
  6633. {
  6634. NAME
  6635. xaosterr - XA Oracle get xa STart ERRor code
  6636. DESCRIPTION
  6637. Given an oracle error code return the XA error code
  6638. }
  6639. {$IFNDEF LinkDynamically}
  6640. function xaosterr(svch:POCISvcCtx; error:sb4):longint;cdecl;external ocilib name 'xaosterr';
  6641. {$ELSE}
  6642. xaosterr : function (svch:POCISvcCtx; error:sb4):longint;cdecl;
  6643. {$ENDIF}
  6644. {-------------------------- End Extensions --------------------------------- }
  6645. {---------------------- Extensions to NLS cartridge service ---------------- }
  6646. { ----------------------- OCINlsGetInfo ------------------------------------ }
  6647. {
  6648. NAME
  6649. OCINlsGetInfo - Get NLS info from OCI environment handle
  6650. REMARKS
  6651. This function generates language information specified by item from OCI
  6652. environment handle envhp into an array pointed to by buf within size
  6653. limitation as buflen.
  6654. RETURNS
  6655. OCI_SUCCESS, OCI_INVALID_HANDLE, or OCI_ERROR on wrong item.
  6656. envhp(IN/OUT)
  6657. OCI environment handle.
  6658. errhp(IN/OUT)
  6659. The OCI error handle. If there is an error, it is record in errhp and
  6660. this function returns a NULL pointer. Diagnostic information can be
  6661. obtained by calling OCIErrorGet().
  6662. buf(OUT)
  6663. Pointer to the destination buffer.
  6664. buflen(IN)
  6665. The size of destination buffer. The maximum length for each information
  6666. is 32 bytes.
  6667. item(IN)
  6668. It specifies to get which item in OCI environment handle and can be one
  6669. of following values:
  6670. OCI_NLS_DAYNAME1 : Native name for Monday.
  6671. OCI_NLS_DAYNAME2 : Native name for Tuesday.
  6672. OCI_NLS_DAYNAME3 : Native name for Wednesday.
  6673. OCI_NLS_DAYNAME4 : Native name for Thursday.
  6674. OCI_NLS_DAYNAME5 : Native name for Friday.
  6675. OCI_NLS_DAYNAME6 : Native name for for Saturday.
  6676. OCI_NLS_DAYNAME7 : Native name for for Sunday.
  6677. OCI_NLS_ABDAYNAME1 : Native abbreviated name for Monday.
  6678. OCI_NLS_ABDAYNAME2 : Native abbreviated name for Tuesday.
  6679. OCI_NLS_ABDAYNAME3 : Native abbreviated name for Wednesday.
  6680. OCI_NLS_ABDAYNAME4 : Native abbreviated name for Thursday.
  6681. OCI_NLS_ABDAYNAME5 : Native abbreviated name for Friday.
  6682. OCI_NLS_ABDAYNAME6 : Native abbreviated name for for Saturday.
  6683. OCI_NLS_ABDAYNAME7 : Native abbreviated name for for Sunday.
  6684. OCI_NLS_MONTHNAME1 : Native name for January.
  6685. OCI_NLS_MONTHNAME2 : Native name for February.
  6686. OCI_NLS_MONTHNAME3 : Native name for March.
  6687. OCI_NLS_MONTHNAME4 : Native name for April.
  6688. OCI_NLS_MONTHNAME5 : Native name for May.
  6689. OCI_NLS_MONTHNAME6 : Native name for June.
  6690. OCI_NLS_MONTHNAME7 : Native name for July.
  6691. OCI_NLS_MONTHNAME8 : Native name for August.
  6692. OCI_NLS_MONTHNAME9 : Native name for September.
  6693. OCI_NLS_MONTHNAME10 : Native name for October.
  6694. OCI_NLS_MONTHNAME11 : Native name for November.
  6695. OCI_NLS_MONTHNAME12 : Native name for December.
  6696. OCI_NLS_ABMONTHNAME1 : Native abbreviated name for January.
  6697. OCI_NLS_ABMONTHNAME2 : Native abbreviated name for February.
  6698. OCI_NLS_ABMONTHNAME3 : Native abbreviated name for March.
  6699. OCI_NLS_ABMONTHNAME4 : Native abbreviated name for April.
  6700. OCI_NLS_ABMONTHNAME5 : Native abbreviated name for May.
  6701. OCI_NLS_ABMONTHNAME6 : Native abbreviated name for June.
  6702. OCI_NLS_ABMONTHNAME7 : Native abbreviated name for July.
  6703. OCI_NLS_ABMONTHNAME8 : Native abbreviated name for August.
  6704. OCI_NLS_ABMONTHNAME9 : Native abbreviated name for September.
  6705. OCI_NLS_ABMONTHNAME10 : Native abbreviated name for October.
  6706. OCI_NLS_ABMONTHNAME11 : Native abbreviated name for November.
  6707. OCI_NLS_ABMONTHNAME12 : Native abbreviated name for December.
  6708. OCI_NLS_YES : Native string for affirmative response.
  6709. OCI_NLS_NO : Native negative response.
  6710. OCI_NLS_AM : Native equivalent string of AM.
  6711. OCI_NLS_PM : Native equivalent string of PM.
  6712. OCI_NLS_AD : Native equivalent string of AD.
  6713. OCI_NLS_BC : Native equivalent string of BC.
  6714. OCI_NLS_DECIMAL : decimal character.
  6715. OCI_NLS_GROUP : group separator.
  6716. OCI_NLS_DEBIT : Native symbol of debit.
  6717. OCI_NLS_CREDIT : Native sumbol of credit.
  6718. OCI_NLS_DATEFORMAT : Oracle date format.
  6719. OCI_NLS_INT_CURRENCY: International currency symbol.
  6720. OCI_NLS_LOC_CURRENCY : Locale currency symbol.
  6721. OCI_NLS_LANGUAGE : Language name.
  6722. OCI_NLS_ABLANGUAGE : Abbreviation for language name.
  6723. OCI_NLS_TERRITORY : Territory name.
  6724. OCI_NLS_CHARACTER_SET : Character set name.
  6725. OCI_NLS_LINGUISTIC : Linguistic name.
  6726. OCI_NLS_CALENDAR : Calendar name.
  6727. OCI_NLS_DUAL_CURRENCY : Dual currency symbol.
  6728. }
  6729. {$IFNDEF LinkDynamically}
  6730. function OCINlsGetInfo(envhp:Pdvoid; errhp:POCIError; buf:POraText; buflen:size_t; item:ub2):sword;cdecl;external ocilib name 'OCINlsGetInfo';
  6731. {$ELSE}
  6732. OCINlsGetInfo : function (envhp:Pdvoid; errhp:POCIError; buf:POraText; buflen:size_t; item:ub2):sword;cdecl;
  6733. {$ENDIF}
  6734. { ----------------------- OCINlsNumericInfoGet ----------------------------- }
  6735. {
  6736. NAME
  6737. OCINlsNumericInfoGet - Get NLS numeric info from OCI environment handle
  6738. REMARKS
  6739. This function generates numeric language information specified by item
  6740. from OCI environment handle envhp into an output number variable.
  6741. RETURNS
  6742. OCI_SUCCESS, OCI_INVALID_HANDLE, or OCI_ERROR on wrong item.
  6743. envhp(IN/OUT)
  6744. OCI environment handle. If handle invalid, returns OCI_INVALID_HANDLE.
  6745. errhp(IN/OUT)
  6746. The OCI error handle. If there is an error, it is record in errhp and
  6747. this function returns a NULL pointer. Diagnostic information can be
  6748. obtained by calling OCIErrorGet().
  6749. val(OUT)
  6750. Pointer to the output number variable. On OCI_SUCCESS return, it will
  6751. contain the requested NLS numeric info.
  6752. item(IN)
  6753. It specifies to get which item in OCI environment handle and can be one
  6754. of following values:
  6755. OCI_NLS_CHARSET_MAXBYTESZ : Maximum character byte size for OCI
  6756. environment or session handle charset
  6757. OCI_NLS_CHARSET_FIXEDWIDTH: Character byte size for fixed-width charset;
  6758. 0 for variable-width charset
  6759. }
  6760. {$IFNDEF LinkDynamically}
  6761. function OCINlsNumericInfoGet(envhp:Pdvoid; errhp:POCIError; val:Psb4; item:ub2):sword;cdecl;external ocilib name 'OCINlsNumericInfoGet';
  6762. {$ELSE}
  6763. OCINlsNumericInfoGet : function (envhp:Pdvoid; errhp:POCIError; val:Psb4; item:ub2):sword;cdecl;
  6764. {$ENDIF}
  6765. { ----------------------- OCINlsCharSetNameToId ---------------------------- }
  6766. {
  6767. NAME
  6768. OCINlsCharSetNameToId - Get Oracle charset id given Oracle charset name
  6769. REMARKS
  6770. This function will get the Oracle character set id corresponding to
  6771. the given Oracle character set name.
  6772. RETURNS
  6773. Oracle character set id for the given Oracle character set name if
  6774. character set name and OCI handle are valid; otherwise returns 0.
  6775. envhp(IN/OUT)
  6776. OCI environment handle.
  6777. name(IN)
  6778. Pointer to a null-terminated Oracle character set name whose id
  6779. will be returned.
  6780. }
  6781. {$IFNDEF LinkDynamically}
  6782. function OCINlsCharSetNameToId(envhp:Pdvoid; name:Poratext):ub2;cdecl;external ocilib name 'OCINlsCharSetNameToId';
  6783. {$ELSE}
  6784. OCINlsCharSetNameToId : function (envhp:Pdvoid; name:Poratext):ub2;cdecl;
  6785. {$ENDIF}
  6786. { ----------------------- OCINlsCharSetIdToName ---------------------------- }
  6787. {
  6788. NAME
  6789. OCINlsCharSetIdToName - Get Oracle charset name given Oracle charset id
  6790. REMARKS
  6791. This function will get the Oracle character set name corresponding to
  6792. the given Oracle character set id.
  6793. RETURNS
  6794. OCI_SUCCESS, OCI_INVALID_HANDLE, or OCI_ERROR
  6795. envhp(IN/OUT)
  6796. OCI environment handle. If handle invalid, returns OCI_INVALID_HANDLE.
  6797. buf(OUT)
  6798. Pointer to the destination buffer. On OCI_SUCCESS return, it will contain
  6799. the null-terminated string for character set name.
  6800. buflen(IN)
  6801. Size of destination buffer. Recommended size is OCI_NLS_MAXBUFSZ for
  6802. guarantee to store an Oracle character set name. If it's smaller than
  6803. the length of the character set name, the function will return OCI_ERROR.
  6804. id(IN)
  6805. Oracle character set id.
  6806. }
  6807. {$IFNDEF LinkDynamically}
  6808. function OCINlsCharSetIdToName(envhp:Pdvoid; buf:Poratext; buflen:size_t; id:ub2):sword;cdecl;external ocilib name 'OCINlsCharSetIdToName';
  6809. {$ELSE}
  6810. OCINlsCharSetIdToName : function (envhp:Pdvoid; buf:Poratext; buflen:size_t; id:ub2):sword;cdecl;
  6811. {$ENDIF}
  6812. { ----------------------- OCINlsNameMap ------------------------------------ }
  6813. {
  6814. NAME
  6815. OCINlsNameMap - Map NLS naming from Oracle to other standards and vice
  6816. versa
  6817. REMARKS
  6818. This function will map NLS naming from Oracle to other standards (such
  6819. as ISO, IANA) and vice versa.
  6820. RETURNS
  6821. OCI_SUCCESS, OCI_INVALID_HANDLE, or OCI_ERROR
  6822. envhp(IN/OUT)
  6823. OCI environment handle. If handle invalid, returns OCI_INVALID_HANDLE.
  6824. buf(OUT)
  6825. Pointer to the destination buffer. On OCI_SUCCESS return, it will
  6826. contain null-terminated string for requested mapped name.
  6827. buflen(IN)
  6828. The size of destination buffer. Recommended size is OCI_NLS_MAXBUFSZ
  6829. for guarantee to store an NLS name. If it is smaller than the length
  6830. of the name, the function will return OCI_ERROR.
  6831. srcbuf(IN)
  6832. Pointer to null-terminated NLS name. If it is not a valid name in its
  6833. define scope, the function will return OCI_ERROR.
  6834. flag(IN)
  6835. It specifies name mapping direction and can take the following values:
  6836. OCI_NLS_CS_IANA_TO_ORA : Map character set name from IANA to Oracle
  6837. OCI_NLS_CS_ORA_TO_IANA : Map character set name from Oracle to IANA
  6838. OCI_NLS_LANG_ISO_TO_ORA : Map language name from ISO to Oracle
  6839. OCI_NLS_LANG_ORA_TO_ISO : Map language name from Oracle to ISO
  6840. OCI_NLS_TERR_ISO_TO_ORA : Map territory name from ISO to Oracle
  6841. OCI_NLS_TERR_ORA_TO_ISO : Map territory name from Oracle to ISO
  6842. OCI_NLS_TERR_ISO3_TO_ORA : Map territory name from 3-letter ISO
  6843. abbreviation to Oracle
  6844. OCI_NLS_TERR_ORA_TO_ISO3 : Map territory name from Oracle to 3-letter
  6845. ISO abbreviation
  6846. }
  6847. {$IFNDEF LinkDynamically}
  6848. function OCINlsNameMap(envhp:Pdvoid; buf:Poratext; buflen:size_t; srcbuf:Poratext; flag:ub4):sword;cdecl;external ocilib name 'OCINlsNameMap';
  6849. {$ELSE}
  6850. OCINlsNameMap : function (envhp:Pdvoid; buf:Poratext; buflen:size_t; srcbuf:Poratext; flag:ub4):sword;cdecl;
  6851. {$ENDIF}
  6852. { -------------------- OCIMultiByteToWideChar ------------------------------ }
  6853. {
  6854. NAME
  6855. OCIMultiByteToWideChar - Convert a null terminated multibyte string into
  6856. wchar
  6857. REMARKS
  6858. This routine converts an entire null-terminated string into the wchar
  6859. format. The wchar output buffer will be null-terminated.
  6860. RETURNS
  6861. OCI_SUCCESS, OCI_INVALID_HANDLE or OCI_ERROR
  6862. envhp(IN/OUT)
  6863. OCI environment handle to determine the character set of string.
  6864. dst (OUT)
  6865. Destination buffer for wchar.
  6866. src (IN)
  6867. Source string to be converted.
  6868. rsize (OUT)
  6869. Number of characters converted including null-terminator.
  6870. If it is a NULL pointer, no number return
  6871. }
  6872. {$IFNDEF LinkDynamically}
  6873. function OCIMultiByteToWideChar(envhp:Pdvoid; dst:POCIWchar; src:POraText; rsize:Psize_t):sword;cdecl;external ocilib name 'OCIMultiByteToWideChar';
  6874. {$ELSE}
  6875. OCIMultiByteToWideChar : function (envhp:Pdvoid; dst:POCIWchar; src:POraText; rsize:Psize_t):sword;cdecl;
  6876. {$ENDIF}
  6877. { --------------------- OCIMultiByteInSizeToWideChar ----------------------- }
  6878. {
  6879. NAME
  6880. OCIMultiByteInSizeToWideChar - Convert a mulitbyte string in length into
  6881. wchar
  6882. REMARKS
  6883. This routine converts part of string into the wchar format. It will
  6884. convert as many complete characters as it can until it reaches output
  6885. buffer size or input buffer size or it reaches a null-terminator in
  6886. source string. The output buffer will be null-terminated if space permits.
  6887. If dstsz is zero, this function will only return number of characters not
  6888. including ending null terminator for converted string.
  6889. RETURNS
  6890. OCI_SUCCESS, OCI_INVALID_HANDLE or OCI_ERROR
  6891. envhp(IN/OUT)
  6892. OCI environment handle to determine the character set of string.
  6893. dst (OUT)
  6894. Pointer to a destination buffer for wchar. It can be NULL pointer when
  6895. dstsz is zero.
  6896. dstsz(IN)
  6897. Destination buffer size in character. If it is zero, this function just
  6898. returns number of characters will be need for the conversion.
  6899. src (IN)
  6900. Source string to be converted.
  6901. srcsz(IN)
  6902. Length of source string in byte.
  6903. rsize(OUT)
  6904. Number of characters written into destination buffer, or number of
  6905. characters for converted string is dstsz is zero.
  6906. If it is NULL pointer, nothing to return.
  6907. }
  6908. {$IFNDEF LinkDynamically}
  6909. function OCIMultiByteInSizeToWideChar(envhp:Pdvoid; dst:POCIWchar; dstsz:size_t; src:POraText; srcsz:size_t;
  6910. rsize:Psize_t):sword;cdecl;external ocilib name 'OCIMultiByteInSizeToWideChar';
  6911. {$ELSE}
  6912. OCIMultiByteInSizeToWideChar : function (envhp:Pdvoid; dst:POCIWchar; dstsz:size_t; src:POraText; srcsz:size_t;
  6913. rsize:Psize_t):sword;cdecl;
  6914. {$ENDIF}
  6915. { ---------------------- OCIWideCharToMultiByte ---------------------------- }
  6916. {
  6917. NAME
  6918. OCIWideCharToMultiByte - Convert a null terminated wchar string into
  6919. multibyte
  6920. REMARKS
  6921. This routine converts an entire null-terminated wide character string into
  6922. multi-byte string. The output buffer will be null-terminated.
  6923. RETURNS
  6924. OCI_SUCCESS, OCI_INVALID_HANDLE or OCI_ERROR
  6925. envhp(IN/OUT)
  6926. OCI environment handle to determine the character set of string.
  6927. dst (OUT)
  6928. Destination buffer for multi-byte string.
  6929. src (IN)
  6930. Source wchar string to be converted.
  6931. rsize (OUT)
  6932. Number of bytes written into the destination buffer.
  6933. If it is NULL pointer, nothing to return.
  6934. }
  6935. {$IFNDEF LinkDynamically}
  6936. function OCIWideCharToMultiByte(envhp:Pdvoid; dst:POraText; src:POCIWchar; rsize:Psize_t):sword;cdecl;external ocilib name 'OCIWideCharToMultiByte';
  6937. {$ELSE}
  6938. OCIWideCharToMultiByte : function (envhp:Pdvoid; dst:POraText; src:POCIWchar; rsize:Psize_t):sword;cdecl;
  6939. {$ENDIF}
  6940. { ---------------------- OCIWideCharInSizeToMultiByte ---------------------- }
  6941. {
  6942. NAME
  6943. OCIWideCharInSizeToMultiByte - Convert a wchar string in length into
  6944. mulitbyte
  6945. REMARKS
  6946. This routine converts part of wchar string into the multi-byte format.
  6947. It will convert as many complete characters as it can until it reaches
  6948. output buffer size or input buffer size or it reaches a null-terminator
  6949. in source string. The output buffer will be null-terminated if space
  6950. permits. If dstsz is zero, the function just returns the size of byte not
  6951. including ending null-terminator need to store the converted string.
  6952. RETURNS
  6953. OCI_SUCCESS, OCI_INVALID_HANDLE or OCI_ERROR
  6954. envhp(IN/OUT)
  6955. OCI environment handle to determine the character set of string.
  6956. dst (OUT)
  6957. Destination buffer for multi-byte. It can be NULL pointer if dstsz is
  6958. zero.
  6959. dstsz(IN)
  6960. Destination buffer size in byte. If it is zero, it just returns the size
  6961. of bytes need for converted string.
  6962. src (IN)
  6963. Source wchar string to be converted.
  6964. srcsz(IN)
  6965. Length of source string in character.
  6966. rsize(OUT)
  6967. Number of bytes written into destination buffer, or number of bytes need
  6968. to store the converted string if dstsz is zero.
  6969. If it is NULL pointer, nothing to return.
  6970. }
  6971. {$IFNDEF LinkDynamically}
  6972. function OCIWideCharInSizeToMultiByte(envhp:Pdvoid; dst:POraText; dstsz:size_t; src:POCIWchar; srcsz:size_t;
  6973. rsize:Psize_t):sword;cdecl;external ocilib name 'OCIWideCharInSizeToMultiByte';
  6974. {$ELSE}
  6975. OCIWideCharInSizeToMultiByte : function (envhp:Pdvoid; dst:POraText; dstsz:size_t; src:POCIWchar; srcsz:size_t;
  6976. rsize:Psize_t):sword;cdecl;
  6977. {$ENDIF}
  6978. { ----------------------- OCIWideCharIsAlnum ------------------------------- }
  6979. {
  6980. NAME
  6981. OCIWideCharIsAlnum - test whether wc is a letter or decimal digit
  6982. REMARKS
  6983. It tests whether wc is a letter or decimal digit.
  6984. RETURNS
  6985. TRUE or FLASE.
  6986. envhp(IN/OUT)
  6987. OCI environment handle to determine the character set .
  6988. wc(IN)
  6989. Wchar for testing.
  6990. }
  6991. {$IFNDEF LinkDynamically}
  6992. function OCIWideCharIsAlnum(envhp:Pdvoid; wc:OCIWchar):boolean;cdecl;external ocilib name 'OCIWideCharIsAlnum';
  6993. {$ELSE}
  6994. OCIWideCharIsAlnum : function (envhp:Pdvoid; wc:OCIWchar):boolean;cdecl;
  6995. {$ENDIF}
  6996. { ----------------------- OCIWideCharIsAlpha ------------------------------- }
  6997. {
  6998. NAME
  6999. OCIWideCharIsAlpha - test whether wc is an alphabetic letter
  7000. REMARKS
  7001. It tests whether wc is an alphabetic letter
  7002. RETURNS
  7003. TRUE or FLASE.
  7004. envhp(IN/OUT)
  7005. OCI environment handle to determine the character set .
  7006. wc(IN)
  7007. Wchar for testing.
  7008. }
  7009. {$IFNDEF LinkDynamically}
  7010. function OCIWideCharIsAlpha(envhp:Pdvoid; wc:OCIWchar):boolean;cdecl;external ocilib name 'OCIWideCharIsAlpha';
  7011. {$ELSE}
  7012. OCIWideCharIsAlpha : function (envhp:Pdvoid; wc:OCIWchar):boolean;cdecl;
  7013. {$ENDIF}
  7014. { --------------------- OCIWideCharIsCntrl --------------------------------- }
  7015. {
  7016. NAME
  7017. OCIWideCharIsCntrl - test whether wc is a control character
  7018. REMARKS
  7019. It tests whether wc is a control character.
  7020. RETURNS
  7021. TRUE or FLASE.
  7022. envhp(IN/OUT)
  7023. OCI environment handle to determine the character set .
  7024. wc(IN)
  7025. Wchar for testing.
  7026. }
  7027. {$IFNDEF LinkDynamically}
  7028. function OCIWideCharIsCntrl(envhp:Pdvoid; wc:OCIWchar):boolean;cdecl;external ocilib name 'OCIWideCharIsCntrl';
  7029. {$ELSE}
  7030. OCIWideCharIsCntrl : function (envhp:Pdvoid; wc:OCIWchar):boolean;cdecl;
  7031. {$ENDIF}
  7032. { ----------------------- OCIWideCharIsDigit ------------------------------- }
  7033. {
  7034. NAME
  7035. OCIWideCharIsDigit - test whether wc is a decimal digit character
  7036. REMARKS
  7037. It tests whether wc is a decimal digit character.
  7038. RETURNS
  7039. TRUE or FLASE.
  7040. envhp(IN/OUT)
  7041. OCI environment handle to determine the character set .
  7042. wc(IN)
  7043. Wchar for testing.
  7044. }
  7045. {$IFNDEF LinkDynamically}
  7046. function OCIWideCharIsDigit(envhp:Pdvoid; wc:OCIWchar):boolean;cdecl;external ocilib name 'OCIWideCharIsDigit';
  7047. {$ELSE}
  7048. OCIWideCharIsDigit : function (envhp:Pdvoid; wc:OCIWchar):boolean;cdecl;
  7049. {$ENDIF}
  7050. { ----------------------- OCIWideCharIsGraph ------------------------------- }
  7051. {
  7052. NAME
  7053. OCIWideCharIsGraph - test whether wc is a graph character
  7054. REMARKS
  7055. It tests whether wc is a graph character. A graph character is character
  7056. with a visible representation and normally includes alphabetic letter,
  7057. decimal digit, and punctuation.
  7058. RETURNS
  7059. TRUE or FLASE.
  7060. envhp(IN/OUT)
  7061. OCI environment handle to determine the character set .
  7062. wc(IN)
  7063. Wchar for testing.
  7064. }
  7065. {$IFNDEF LinkDynamically}
  7066. function OCIWideCharIsGraph(envhp:Pdvoid; wc:OCIWchar):boolean;cdecl;external ocilib name 'OCIWideCharIsGraph';
  7067. {$ELSE}
  7068. OCIWideCharIsGraph : function (envhp:Pdvoid; wc:OCIWchar):boolean;cdecl;
  7069. {$ENDIF}
  7070. { ----------------------- OCIWideCharIsLower ------------------------------- }
  7071. {
  7072. NAME
  7073. OCIWideCharIsLower - test whether wc is a lowercase letter
  7074. REMARKS
  7075. It tests whether wc is a lowercase letter.
  7076. RETURNS
  7077. TRUE or FLASE.
  7078. envhp(IN/OUT)
  7079. OCI environment handle to determine the character set .
  7080. wc(IN)
  7081. Wchar for testing.
  7082. }
  7083. {$IFNDEF LinkDynamically}
  7084. function OCIWideCharIsLower(envhp:Pdvoid; wc:OCIWchar):boolean;cdecl;external ocilib name 'OCIWideCharIsLower';
  7085. {$ELSE}
  7086. OCIWideCharIsLower : function (envhp:Pdvoid; wc:OCIWchar):boolean;cdecl;
  7087. {$ENDIF}
  7088. { ----------------------- OCIWideCharIsPrint ------------------------------- }
  7089. {
  7090. NAME
  7091. OCIWideCharIsPrint - test whether wc is a printable character
  7092. REMARKS
  7093. It tests whether wc is a printable character.
  7094. RETURNS
  7095. TRUE or FLASE.
  7096. envhp(IN/OUT)
  7097. OCI environment handle to determine the character set .
  7098. wc(IN)
  7099. Wchar for testing.
  7100. }
  7101. {$IFNDEF LinkDynamically}
  7102. function OCIWideCharIsPrint(envhp:Pdvoid; wc:OCIWchar):boolean;cdecl;external ocilib name 'OCIWideCharIsPrint';
  7103. {$ELSE}
  7104. OCIWideCharIsPrint : function (envhp:Pdvoid; wc:OCIWchar):boolean;cdecl;
  7105. {$ENDIF}
  7106. { ----------------------- OCIWideCharIsPunct ------------------------------- }
  7107. {
  7108. NAME
  7109. OCIWideCharIsPunct - test whether wc is a punctuation character
  7110. REMARKS
  7111. It tests whether wc is a punctuation character.
  7112. RETURNS
  7113. TRUE or FLASE.
  7114. envhp(IN/OUT)
  7115. OCI environment handle to determine the character set .
  7116. wc(IN)
  7117. Wchar for testing.
  7118. }
  7119. {$IFNDEF LinkDynamically}
  7120. function OCIWideCharIsPunct(envhp:Pdvoid; wc:OCIWchar):boolean;cdecl;external ocilib name 'OCIWideCharIsPunct';
  7121. {$ELSE}
  7122. OCIWideCharIsPunct : function (envhp:Pdvoid; wc:OCIWchar):boolean;cdecl;
  7123. {$ENDIF}
  7124. { ----------------------- OCIWideCharIsSpace ------------------------------- }
  7125. {
  7126. NAME
  7127. OCIWideCharIsSpace - test whether wc is a space character
  7128. REMARKS
  7129. It tests whether wc is a space character. A space character only causes
  7130. white space in displayed text(for example, space, tab, carriage return,
  7131. newline, vertical tab or form feed).
  7132. RETURNS
  7133. TRUE or FLASE.
  7134. envhp(IN/OUT)
  7135. OCI environment handle to determine the character set .
  7136. wc(IN)
  7137. Wchar for testing.
  7138. }
  7139. {$IFNDEF LinkDynamically}
  7140. function OCIWideCharIsSpace(envhp:Pdvoid; wc:OCIWchar):boolean;cdecl;external ocilib name 'OCIWideCharIsSpace';
  7141. {$ELSE}
  7142. OCIWideCharIsSpace : function (envhp:Pdvoid; wc:OCIWchar):boolean;cdecl;
  7143. {$ENDIF}
  7144. { ----------------------- OCIWideCharIsUpper ------------------------------- }
  7145. {
  7146. NAME
  7147. OCIWideCharIsUpper - test whether wc is a uppercase letter
  7148. REMARKS
  7149. It tests whether wc is a uppercase letter.
  7150. RETURNS
  7151. TRUE or FLASE.
  7152. envhp(IN/OUT)
  7153. OCI environment handle to determine the character set .
  7154. wc(IN)
  7155. Wchar for testing.
  7156. }
  7157. {$IFNDEF LinkDynamically}
  7158. function OCIWideCharIsUpper(envhp:Pdvoid; wc:OCIWchar):boolean;cdecl;external ocilib name 'OCIWideCharIsUpper';
  7159. {$ELSE}
  7160. OCIWideCharIsUpper : function (envhp:Pdvoid; wc:OCIWchar):boolean;cdecl;
  7161. {$ENDIF}
  7162. {----------------------- OCIWideCharIsXdigit ------------------------------- }
  7163. {
  7164. NAME
  7165. OCIWideCharIsXdigit - test whether wc is a hexadecimal digit
  7166. REMARKS
  7167. It tests whether wc is a hexadecimal digit ( 0-9, A-F, a-f ).
  7168. RETURNS
  7169. TRUE or FLASE.
  7170. envhp(IN/OUT)
  7171. OCI environment handle to determine the character set .
  7172. wc(IN)
  7173. Wchar for testing.
  7174. }
  7175. {$IFNDEF LinkDynamically}
  7176. function OCIWideCharIsXdigit(envhp:Pdvoid; wc:OCIWchar):boolean;cdecl;external ocilib name 'OCIWideCharIsXdigit';
  7177. {$ELSE}
  7178. OCIWideCharIsXdigit : function (envhp:Pdvoid; wc:OCIWchar):boolean;cdecl;
  7179. {$ENDIF}
  7180. { --------------------- OCIWideCharIsSingleByte ---------------------------- }
  7181. {
  7182. NAME
  7183. OCIWideCharIsSingleByte - test whether wc is a single-byte character
  7184. REMARKS
  7185. It tests whether wc is a single-byte character when converted into
  7186. multi-byte.
  7187. RETURNS
  7188. TRUE or FLASE.
  7189. envhp(IN/OUT)
  7190. OCI environment handle to determine the character set .
  7191. wc(IN)
  7192. Wchar for testing.
  7193. }
  7194. {$IFNDEF LinkDynamically}
  7195. function OCIWideCharIsSingleByte(envhp:Pdvoid; wc:OCIWchar):boolean;cdecl;external ocilib name 'OCIWideCharIsSingleByte';
  7196. {$ELSE}
  7197. OCIWideCharIsSingleByte : function (envhp:Pdvoid; wc:OCIWchar):boolean;cdecl;
  7198. {$ENDIF}
  7199. { ----------------------- OCIWideCharToLower ------------------------------- }
  7200. {
  7201. NAME
  7202. OCIWideCharToLower - Convert a wchar into the lowercase
  7203. REMARKS
  7204. If there is a lower-case character mapping for wc in the specified locale,
  7205. it will return the lower-case in wchar, else return wc itself.
  7206. RETURNS
  7207. A wchar
  7208. envhp(IN/OUT)
  7209. OCI environment handle to determine the character set .
  7210. wc(IN)
  7211. Wchar for lowercase mapping.
  7212. }
  7213. {$IFNDEF LinkDynamically}
  7214. function OCIWideCharToLower(envhp:Pdvoid; wc:OCIWchar):OCIWchar;cdecl;external ocilib name 'OCIWideCharToLower';
  7215. {$ELSE}
  7216. OCIWideCharToLower : function (envhp:Pdvoid; wc:OCIWchar):OCIWchar;cdecl;
  7217. {$ENDIF}
  7218. { ----------------------- OCIWideCharToUpper ------------------------------- }
  7219. {
  7220. NAME
  7221. OCIWideCharToUpper - Convert a wchar into the uppercase
  7222. REMARKS
  7223. If there is a upper-case character mapping for wc in the specified locale,
  7224. it will return the upper-case in wchar, else return wc itself.
  7225. RETURNS
  7226. A wchar
  7227. envhp(IN/OUT)
  7228. OCI environment handle to determine the character set .
  7229. wc(IN)
  7230. Wchar for uppercase mapping.
  7231. }
  7232. {$IFNDEF LinkDynamically}
  7233. function OCIWideCharToUpper(envhp:Pdvoid; wc:OCIWchar):OCIWchar;cdecl;external ocilib name 'OCIWideCharToUpper';
  7234. {$ELSE}
  7235. OCIWideCharToUpper : function (envhp:Pdvoid; wc:OCIWchar):OCIWchar;cdecl;
  7236. {$ENDIF}
  7237. { ----------------------- OCIWideCharStrcmp -------------------------------- }
  7238. {
  7239. NAME
  7240. OCIWideCharStrcmp - compare two null terminated wchar string
  7241. REMARKS
  7242. It compares two wchar string in binary ( based on wchar encoding value ),
  7243. linguistic, or case-insensitive.
  7244. RETURNS
  7245. 0, if wstr1 == wstr2.
  7246. Positive, if wstr1 > wstr2.
  7247. Negative, if wstr1 < wstr2.
  7248. envhp(IN/OUT)
  7249. OCI environment handle to determine the character set.
  7250. wstr1(IN)
  7251. Pointer to a null-terminated wchar string.
  7252. wstr2(IN)
  7253. Pointer to a null-terminated wchar string.
  7254. flag(IN)
  7255. It is used to decide the comparison method. It can be taken one of the
  7256. following values:
  7257. OCI_NLS_BINARY : for the binary comparison, this is default value.
  7258. OCI_NLS_LINGUISTIC : for linguistic comparison specified in the locale.
  7259. This flag can be ORed with OCI_NLS_CASE_INSENSITIVE for case-insensitive
  7260. comparison.
  7261. }
  7262. {$IFNDEF LinkDynamically}
  7263. function OCIWideCharStrcmp(envhp:Pdvoid; wstr1:POCIWchar; wstr2:POCIWchar; flag:longint):longint;cdecl;external ocilib name 'OCIWideCharStrcmp';
  7264. {$ELSE}
  7265. OCIWideCharStrcmp : function (envhp:Pdvoid; wstr1:POCIWchar; wstr2:POCIWchar; flag:longint):longint;cdecl;
  7266. {$ENDIF}
  7267. { ----------------------- OCIWideCharStrncmp ------------------------------- }
  7268. {
  7269. NAME
  7270. OCIWideCharStrncmp - compare twe wchar string in length
  7271. REMARKS
  7272. This function is similar to OCIWideCharStrcmp(), except that at most len1
  7273. characters from wstr1 and len2 characters from wstr1 are compared. The
  7274. null-terminator will be taken into the comparison.
  7275. RETURNS
  7276. 0, if wstr1 = wstr2
  7277. Positive, if wstr1 > wstr2
  7278. Negative, if wstr1 < wstr2
  7279. envhp(IN/OUT)
  7280. OCI environment handle to determine the character set .
  7281. wstr1(IN)
  7282. Pointer to the first wchar string
  7283. len1(IN)
  7284. The length for the first string for comparison
  7285. wstr2(IN)
  7286. Pointer to the second wchar string
  7287. len2(IN)
  7288. The length for the second string for comparison.
  7289. flag(IN)
  7290. It is used to decide the comparison method. It can be taken one of the
  7291. following values:
  7292. OCI_NLS_BINARY : for the binary comparison, this is default value.
  7293. OCI_NLS_LINGUISTIC : for linguistic comparison specified in the locale.
  7294. This flag can be ORed with OCI_NLS_CASE_INSENSITIVE for case-insensitive
  7295. comparison.
  7296. }
  7297. {$IFNDEF LinkDynamically}
  7298. function OCIWideCharStrncmp(envhp:Pdvoid; wstr1:POCIWchar; len1:size_t; wstr2:POCIWchar; len2:size_t;
  7299. flag:longint):longint;cdecl;external ocilib name 'OCIWideCharStrncmp';
  7300. {$ELSE}
  7301. OCIWideCharStrncmp : function (envhp:Pdvoid; wstr1:POCIWchar; len1:size_t; wstr2:POCIWchar; len2:size_t;
  7302. flag:longint):longint;cdecl;
  7303. {$ENDIF}
  7304. { ----------------------- OCIWideCharStrcat -------------------------------- }
  7305. {
  7306. NAME
  7307. OCIWideCharStrcat - concatenate two wchar strings
  7308. REMARKS
  7309. This function appends a copy of the wchar string pointed to by wsrcstr,
  7310. including the null-terminator to the end of wchar string pointed to by
  7311. wdststr. It returns the number of character in the result string not
  7312. including the ending null-terminator.
  7313. RETURNS
  7314. number of characters in the result string not including the ending
  7315. null-terminator.
  7316. envhp(IN/OUT)
  7317. OCI environment handle to determine the character set .
  7318. wdststr(IN/OUT)
  7319. Pointer to the destination wchar string for appending.
  7320. wsrcstr(IN)
  7321. Pointer to the source wchar string to append.
  7322. }
  7323. {$IFNDEF LinkDynamically}
  7324. function OCIWideCharStrcat(envhp:Pdvoid; wdststr:POCIWchar; wsrcstr:POCIWchar):size_t;cdecl;external ocilib name 'OCIWideCharStrcat';
  7325. {$ELSE}
  7326. OCIWideCharStrcat : function (envhp:Pdvoid; wdststr:POCIWchar; wsrcstr:POCIWchar):size_t;cdecl;
  7327. {$ENDIF}
  7328. { ----------------------- OCIWideCharStrchr -------------------------------- }
  7329. {
  7330. NAME
  7331. OCIWideCharStrchr - Search the first occurrence of wchar in a wchar string
  7332. REMARKS
  7333. This function searchs for the first occurrence of wc in the wchar string
  7334. pointed to by wstr. It returns a pointer to the whcar if successful, or
  7335. a null pointer.
  7336. RETURNS
  7337. wchar pointer if successful, otherwise a null pointer.
  7338. envhp(IN/OUT)
  7339. OCI environment handle to determine the character set .
  7340. wstr(IN)
  7341. Pointer to the wchar string to search
  7342. wc(IN)
  7343. Wchar to search for.
  7344. }
  7345. {$IFNDEF LinkDynamically}
  7346. function OCIWideCharStrchr(envhp:Pdvoid; wstr:POCIWchar; wc:OCIWchar):POCIWchar;cdecl;external ocilib name 'OCIWideCharStrchr';
  7347. {$ELSE}
  7348. OCIWideCharStrchr : function (envhp:Pdvoid; wstr:POCIWchar; wc:OCIWchar):POCIWchar;cdecl;
  7349. {$ENDIF}
  7350. { ----------------------- OCIWideCharStrcpy -------------------------------- }
  7351. {
  7352. NAME
  7353. OCIWideCharStrcpy - copy a wchar string
  7354. REMARKS
  7355. This function copies the wchar string pointed to by wsrcstr, including the
  7356. null-terminator, into the array pointed to by wdststr. It returns the
  7357. number of character copied not including the ending null-terminator.
  7358. RETURNS
  7359. number of characters copied not including the ending null-terminator.
  7360. envhp(IN/OUT)
  7361. OCI environment handle to determine the character set .
  7362. wdststr(OUT)
  7363. Pointer to the destination wchar buffer.
  7364. wsrcstr(IN)
  7365. Pointer to the source wchar string.
  7366. }
  7367. {$IFNDEF LinkDynamically}
  7368. function OCIWideCharStrcpy(envhp:Pdvoid; wdststr:POCIWchar; wsrcstr:POCIWchar):size_t;cdecl;external ocilib name 'OCIWideCharStrcpy';
  7369. {$ELSE}
  7370. OCIWideCharStrcpy : function (envhp:Pdvoid; wdststr:POCIWchar; wsrcstr:POCIWchar):size_t;cdecl;
  7371. {$ENDIF}
  7372. { ----------------------- OCIWideCharStrlen -------------------------------- }
  7373. {
  7374. NAME
  7375. OCIWideCharStrlen - Return number of character in a wchar string
  7376. REMARKS
  7377. This function computes the number of characters in the wchar string
  7378. pointed to by wstr, not including the null-terminator, and returns
  7379. this number.
  7380. RETURNS
  7381. number of characters not including ending null-terminator.
  7382. envhp(IN/OUT)
  7383. OCI environment handle to determine the character set .
  7384. wstr(IN)
  7385. Pointer to the source wchar string.
  7386. }
  7387. {$IFNDEF LinkDynamically}
  7388. function OCIWideCharStrlen(envhp:Pdvoid; wstr:POCIWchar):size_t;cdecl;external ocilib name 'OCIWideCharStrlen';
  7389. {$ELSE}
  7390. OCIWideCharStrlen : function (envhp:Pdvoid; wstr:POCIWchar):size_t;cdecl;
  7391. {$ENDIF}
  7392. { ----------------------- OCIWideCharStrncat ------------------------------- }
  7393. {
  7394. NAME
  7395. OCIWideCharStrncat - Concatenate wchar string in length
  7396. REMARKS
  7397. This function is similar to OCIWideCharStrcat(), except that at most n
  7398. characters from wsrcstr are appended to wdststr. Note that the
  7399. null-terminator in wsrcstr will stop appending. wdststr will be
  7400. null-terminated..
  7401. RETURNS
  7402. Number of characters in the result string not including the ending
  7403. null-terminator.
  7404. envhp(IN/OUT)
  7405. OCI environment handle to determine the character set .
  7406. wdststr(IN/OUT)
  7407. Pointer to the destination wchar string for appending.
  7408. wsrcstr(IN)
  7409. Pointer to the source wchar string to append.
  7410. n(IN)
  7411. Number of characters from wsrcstr to append.
  7412. }
  7413. {$IFNDEF LinkDynamically}
  7414. function OCIWideCharStrncat(envhp:Pdvoid; wdststr:POCIWchar; wsrcstr:POCIWchar; n:size_t):size_t;cdecl;external ocilib name 'OCIWideCharStrncat';
  7415. {$ELSE}
  7416. OCIWideCharStrncat : function (envhp:Pdvoid; wdststr:POCIWchar; wsrcstr:POCIWchar; n:size_t):size_t;cdecl;
  7417. {$ENDIF}
  7418. { ----------------------- OCIWideCharStrncpy ------------------------------- }
  7419. {
  7420. NAME
  7421. OCIWideCharStrncpy - Copy wchar string in length
  7422. REMARKS
  7423. This function is similar to OCIWideCharStrcpy(), except that at most n
  7424. characters are copied from the array pointed to by wsrcstr to the array
  7425. pointed to by wdststr. Note that the null-terminator in wdststr will
  7426. stop coping and result string will be null-terminated.
  7427. RETURNS
  7428. number of characters copied not including the ending null-terminator.
  7429. envhp(IN/OUT)
  7430. OCI environment handle to determine the character set .
  7431. wdststr(OUT)
  7432. Pointer to the destination wchar buffer.
  7433. wsrcstr(IN)
  7434. Pointer to the source wchar string.
  7435. n(IN)
  7436. Number of characters from wsrcstr to copy.
  7437. }
  7438. {$IFNDEF LinkDynamically}
  7439. function OCIWideCharStrncpy(envhp:Pdvoid; wdststr:POCIWchar; wsrcstr:POCIWchar; n:size_t):size_t;cdecl;external ocilib name 'OCIWideCharStrncpy';
  7440. {$ELSE}
  7441. OCIWideCharStrncpy : function (envhp:Pdvoid; wdststr:POCIWchar; wsrcstr:POCIWchar; n:size_t):size_t;cdecl;
  7442. {$ENDIF}
  7443. { ----------------------- OCIWideCharStrrchr ------------------------------- }
  7444. {
  7445. NAME
  7446. OCIWideCharStrrchr - search the last occurrence of a wchar in wchar string
  7447. REMARKS
  7448. This function searchs for the last occurrence of wc in the wchar string
  7449. pointed to by wstr. It returns a pointer to the whcar if successful, or
  7450. a null pointer.
  7451. RETURNS
  7452. wchar pointer if successful, otherwise a null pointer.
  7453. envhp(IN/OUT)
  7454. OCI environment handle to determine the character set .
  7455. wstr(IN)
  7456. Pointer to the wchar string to search
  7457. wc(IN)
  7458. Wchar to search for.
  7459. }
  7460. {$IFNDEF LinkDynamically}
  7461. function OCIWideCharStrrchr(envhp:Pdvoid; wstr:POCIWchar; wc:OCIWchar):POCIWchar;cdecl;external ocilib name 'OCIWideCharStrrchr';
  7462. {$ELSE}
  7463. OCIWideCharStrrchr : function (envhp:Pdvoid; wstr:POCIWchar; wc:OCIWchar):POCIWchar;cdecl;
  7464. {$ENDIF}
  7465. { --------------------- OCIWideCharStrCaseConversion ----------------------- }
  7466. {
  7467. NAME
  7468. OCIWideCharStrCaseConversion - convert a wchar string into lowercase or
  7469. uppercase
  7470. REMARKS
  7471. This function convert the wide char string pointed to by wsrcstr into the
  7472. uppercase or lowercase specified by flag and copies the result into the
  7473. array pointed to by wdststr. The result string will be null-terminated.
  7474. RETURNS
  7475. number of characters for result string not including null-terminator.
  7476. envhp(IN/OUT)
  7477. OCI environment handle.
  7478. wdststr(OUT)
  7479. Pointer to destination array.
  7480. wsrcstr(IN)
  7481. Pointer to source string.
  7482. flag(IN)
  7483. Specify the case to convert:
  7484. OCI_NLS_UPPERCASE : convert to uppercase.
  7485. OCI_NLS_LOWERCASE: convert to lowercase.
  7486. This flag can be ORed with OCI_NLS_LINGUISTIC to specify that the
  7487. linguistic setting in the locale will be used for case conversion.
  7488. }
  7489. {$IFNDEF LinkDynamically}
  7490. function OCIWideCharStrCaseConversion(envhp:Pdvoid; wdststr:POCIWchar; wsrcstr:POCIWchar; flag:ub4):size_t;cdecl;external ocilib name 'OCIWideCharStrCaseConversion';
  7491. {$ELSE}
  7492. OCIWideCharStrCaseConversion : function (envhp:Pdvoid; wdststr:POCIWchar; wsrcstr:POCIWchar; flag:ub4):size_t;cdecl;
  7493. {$ENDIF}
  7494. {---------------------- OCIWideCharDisplayLength --------------------------- }
  7495. {
  7496. NAME
  7497. OCIWideCharDisplayLength - Calculate the display length for a wchar
  7498. REMARKS
  7499. This function determines the number of column positions required for wc
  7500. in display. It returns number of column positions, or 0 if wc is
  7501. null-terminator.
  7502. RETURNS
  7503. Number of display positions.
  7504. envhp(IN/OUT)
  7505. OCI environment handle to determine the character set .
  7506. wc(IN)
  7507. Wchar character.
  7508. }
  7509. {$IFNDEF LinkDynamically}
  7510. function OCIWideCharDisplayLength(envhp:Pdvoid; wc:OCIWchar):size_t;cdecl;external ocilib name 'OCIWideCharDisplayLength';
  7511. {$ELSE}
  7512. OCIWideCharDisplayLength : function (envhp:Pdvoid; wc:OCIWchar):size_t;cdecl;
  7513. {$ENDIF}
  7514. {---------------------- OCIWideCharMultiByteLength ------------------------- }
  7515. {
  7516. NAME
  7517. OCIWideCharMultiByteLength - Determine byte size in multi-byte encoding
  7518. REMARKS
  7519. This function determines the number of byte required for wc in multi-byte
  7520. encoding. It returns number of bytes in multi-byte for wc.
  7521. RETURNS
  7522. Number of bytes.
  7523. envhp(IN/OUT)
  7524. OCI environment handle to determine the character set .
  7525. wc(IN)
  7526. Wchar character.
  7527. }
  7528. {$IFNDEF LinkDynamically}
  7529. function OCIWideCharMultiByteLength(envhp:Pdvoid; wc:OCIWchar):size_t;cdecl;external ocilib name 'OCIWideCharMultiByteLength';
  7530. {$ELSE}
  7531. OCIWideCharMultiByteLength : function (envhp:Pdvoid; wc:OCIWchar):size_t;cdecl;
  7532. {$ENDIF}
  7533. { ----------------------- OCIMultiByteStrcmp ------------------------------- }
  7534. {
  7535. NAME
  7536. OCIMultiByteStrcmp - Compare two multi-byte strings
  7537. REMARKS
  7538. It compares two multi-byte strings in binary ( based on encoding value ),
  7539. linguistic, or case-insensitive.
  7540. RETURNS
  7541. 0, if str1 == str2.
  7542. Positive, if str1 > str2.
  7543. Negative, if str1 < str2.
  7544. envhp(IN/OUT)
  7545. OCI environment handle to determine the character set.
  7546. str1(IN)
  7547. Pointer to a null-terminated string.
  7548. str2(IN)
  7549. Pointer to a null-terminated string.
  7550. flag(IN)
  7551. It is used to decide the comparison method. It can be taken one of the
  7552. following values:
  7553. OCI_NLS_BINARY: for the binary comparison, this is default value.
  7554. OCI_NLS_LINGUISTIC: for linguistic comparison specified in the locale.
  7555. This flag can be ORed with OCI_NLS_CASE_INSENSITIVE for case-insensitive
  7556. comparison.
  7557. }
  7558. {$IFNDEF LinkDynamically}
  7559. function OCIMultiByteStrcmp(envhp:Pdvoid; str1:POraText; str2:POraText; flag:longint):longint;cdecl;external ocilib name 'OCIMultiByteStrcmp';
  7560. {$ELSE}
  7561. OCIMultiByteStrcmp : function (envhp:Pdvoid; str1:POraText; str2:POraText; flag:longint):longint;cdecl;
  7562. {$ENDIF}
  7563. {----------------------- OCIMultiByteStrncmp ------------------------------- }
  7564. {
  7565. NAME
  7566. OCIMultiByteStrncmp - compare two strings in length
  7567. REMARKS
  7568. This function is similar to OCIMultiBytestrcmp(), except that at most
  7569. len1 bytes from str1 and len2 bytes from str2 are compared. The
  7570. null-terminator will be taken into the comparison.
  7571. RETURNS
  7572. 0, if str1 = str2
  7573. Positive, if str1 > str2
  7574. Negative, if str1 < str2
  7575. envhp(IN/OUT)
  7576. OCI environment handle to determine the character set.
  7577. str1(IN)
  7578. Pointer to the first string
  7579. len1(IN)
  7580. The length for the first string for comparison
  7581. str2(IN)
  7582. Pointer to the second string
  7583. len2(IN)
  7584. The length for the second string for comparison.
  7585. flag(IN)
  7586. It is used to decide the comparison method. It can be taken one of the
  7587. following values:
  7588. OCI_NLS_BINARY: for the binary comparison, this is default value.
  7589. OCI_NLS_LINGUISTIC: for linguistic comparison specified in the locale.
  7590. This flag can be ORed with OCI_NLS_CASE_INSENSITIVE for case-insensitive
  7591. comparison.
  7592. }
  7593. {$IFNDEF LinkDynamically}
  7594. function OCIMultiByteStrncmp(envhp:Pdvoid; str1:POraText; len1:size_t; str2:POraText; len2:size_t;
  7595. flag:longint):longint;cdecl;external ocilib name 'OCIMultiByteStrncmp';
  7596. {$ELSE}
  7597. OCIMultiByteStrncmp : function (envhp:Pdvoid; str1:POraText; len1:size_t; str2:POraText; len2:size_t;
  7598. flag:longint):longint;cdecl;
  7599. {$ENDIF}
  7600. {----------------------- OCIMultiByteStrcat -------------------------------- }
  7601. {
  7602. NAME
  7603. OCIMultiByteStrcat - concatenate multibyte strings
  7604. REMARKS
  7605. This function appends a copy of the multi-byte string pointed to by
  7606. srcstr, including the null-terminator to the end of string pointed to by
  7607. dststr. It returns the number of bytes in the result string not including
  7608. the ending null-terminator.
  7609. RETURNS
  7610. number of bytes in the result string not including the ending
  7611. null-terminator.
  7612. envhp(IN/OUT)
  7613. Pointer to OCI environment handle
  7614. dststr(IN/OUT)
  7615. Pointer to the destination multi-byte string for appending.
  7616. srcstr(IN)
  7617. Pointer to the source string to append.
  7618. }
  7619. {$IFNDEF LinkDynamically}
  7620. function OCIMultiByteStrcat(envhp:Pdvoid; dststr:POraText; srcstr:POraText):size_t;cdecl;external ocilib name 'OCIMultiByteStrcat';
  7621. {$ELSE}
  7622. OCIMultiByteStrcat : function (envhp:Pdvoid; dststr:POraText; srcstr:POraText):size_t;cdecl;
  7623. {$ENDIF}
  7624. {------------------------- OCIMultiByteStrcpy ------------------------------ }
  7625. {
  7626. NAME
  7627. OCIMultiByteStrcpy - copy multibyte string
  7628. REMARKS
  7629. This function copies the multi-byte string pointed to by srcstr,
  7630. including the null-terminator, into the array pointed to by dststr. It
  7631. returns the number of bytes copied not including the ending
  7632. null-terminator.
  7633. RETURNS
  7634. number of bytes copied not including the ending null-terminator.
  7635. envhp(IN/OUT)
  7636. Pointer to the OCI environment handle.
  7637. srcstr(OUT)
  7638. Pointer to the destination buffer.
  7639. dststr(IN)
  7640. Pointer to the source multi-byte string.
  7641. }
  7642. {$IFNDEF LinkDynamically}
  7643. function OCIMultiByteStrcpy(envhp:Pdvoid; dststr:POraText; srcstr:POraText):size_t;cdecl;external ocilib name 'OCIMultiByteStrcpy';
  7644. {$ELSE}
  7645. OCIMultiByteStrcpy : function (envhp:Pdvoid; dststr:POraText; srcstr:POraText):size_t;cdecl;
  7646. {$ENDIF}
  7647. {----------------------- OCIMultiByteStrlen -------------------------------- }
  7648. {
  7649. NAME
  7650. OCIMultiByteStrlen - Calculate multibyte string length
  7651. REMARKS
  7652. This function computes the number of bytes in the multi-byte string
  7653. pointed to by str, not including the null-terminator, and returns this
  7654. number.
  7655. RETURNS
  7656. number of bytes not including ending null-terminator.
  7657. str(IN)
  7658. Pointer to the source multi-byte string.
  7659. }
  7660. {$IFNDEF LinkDynamically}
  7661. function OCIMultiByteStrlen(envhp:Pdvoid; str:POraText):size_t;cdecl;external ocilib name 'OCIMultiByteStrlen';
  7662. {$ELSE}
  7663. OCIMultiByteStrlen : function (envhp:Pdvoid; str:POraText):size_t;cdecl;
  7664. {$ENDIF}
  7665. {----------------------- OCIMultiByteStrncat ------------------------------- }
  7666. {
  7667. NAME
  7668. OCIMultiByteStrncat - concatenate string in length
  7669. REMARKS
  7670. This function is similar to OCIMultiBytestrcat(), except that at most n
  7671. bytes from srcstr are appended to dststr. Note that the null-terminator in
  7672. srcstr will stop appending and the function will append as many character
  7673. as possible within n bytes. dststr will be null-terminated.
  7674. RETURNS
  7675. Number of bytes in the result string not including the ending
  7676. null-terminator.
  7677. envhp(IN/OUT)
  7678. Pointer to OCI environment handle.
  7679. srcstr(IN/OUT)
  7680. Pointer to the destination multi-byte string for appending.
  7681. dststr(IN)
  7682. Pointer to the source multi-byte string to append.
  7683. n(IN)
  7684. Number of bytes from srcstr to append.
  7685. }
  7686. {$IFNDEF LinkDynamically}
  7687. function OCIMultiByteStrncat(envhp:Pdvoid; dststr:POraText; srcstr:POraText; n:size_t):size_t;cdecl;external ocilib name 'OCIMultiByteStrncat';
  7688. {$ELSE}
  7689. OCIMultiByteStrncat : function (envhp:Pdvoid; dststr:POraText; srcstr:POraText; n:size_t):size_t;cdecl;
  7690. {$ENDIF}
  7691. {----------------------- OCIMultiByteStrncpy ------------------------------- }
  7692. {
  7693. NAME
  7694. OCIMultiByteStrncpy - copy multibyte string in length
  7695. REMARKS
  7696. This function is similar to OCIMultiBytestrcpy(), except that at most n
  7697. bytes are copied from the array pointed to by srcstr to the array pointed
  7698. to by dststr. Note that the null-terminator in srcstr will stop coping and
  7699. the function will copy as many character as possible within n bytes. The
  7700. result string will be null-terminated.
  7701. RETURNS
  7702. number of bytes copied not including the ending null-terminator.
  7703. envhp(IN/OUT)
  7704. Pointer to a OCI environment handle.
  7705. dststr(IN)
  7706. Pointer to the source multi-byte string.
  7707. srcstr(OUT)
  7708. Pointer to the destination buffer.
  7709. n(IN)
  7710. Number of bytes from srcstr to copy.
  7711. }
  7712. {$IFNDEF LinkDynamically}
  7713. function OCIMultiByteStrncpy(envhp:Pdvoid; dststr:POraText; srcstr:POraText; n:size_t):size_t;cdecl;external ocilib name 'OCIMultiByteStrncpy';
  7714. {$ELSE}
  7715. OCIMultiByteStrncpy : function (envhp:Pdvoid; dststr:POraText; srcstr:POraText; n:size_t):size_t;cdecl;
  7716. {$ENDIF}
  7717. {----------------------- OCIMultiByteStrnDisplayLength --------------------- }
  7718. {
  7719. NAME
  7720. OCIMultiByteStrnDisplayLength - calculate the display length for a
  7721. multibyt string
  7722. REMARKS
  7723. This function returns the number of display positions occupied by the
  7724. complete characters within the range of n bytes.
  7725. RETURNS
  7726. number of display positions.
  7727. envhp(IN/OUT)
  7728. OCI environment handle.
  7729. str(IN)
  7730. Pointer to a multi-byte string.
  7731. n(IN)
  7732. Number of bytes to examine.
  7733. }
  7734. {$IFNDEF LinkDynamically}
  7735. function OCIMultiByteStrnDisplayLength(envhp:Pdvoid; str1:POraText; n:size_t):size_t;cdecl;external ocilib name 'OCIMultiByteStrnDisplayLength';
  7736. {$ELSE}
  7737. OCIMultiByteStrnDisplayLength : function (envhp:Pdvoid; str1:POraText; n:size_t):size_t;cdecl;
  7738. {$ENDIF}
  7739. {---------------------- OCIMultiByteStrCaseConversion --------------------- }
  7740. {
  7741. NAME
  7742. OCIMultiByteStrCaseConversion
  7743. REMARKS
  7744. This function convert the multi-byte string pointed to by srcstr into the
  7745. uppercase or lowercase specified by flag and copies the result into the
  7746. array pointed to by dststr. The result string will be null-terminated.
  7747. RETURNS
  7748. number of bytes for result string not including null-terminator.
  7749. envhp(IN/OUT)
  7750. OCI environment handle.
  7751. dststr(OUT)
  7752. Pointer to destination array.
  7753. srcstr(IN)
  7754. Pointer to source string.
  7755. flag(IN)
  7756. Specify the case to convert:
  7757. OCI_NLS_UPPERCASE: convert to uppercase.
  7758. OCI_NLS_LOWERCASE: convert to lowercase.
  7759. This flag can be ORed with OCI_NLS_LINGUISTIC to specify that the
  7760. linguistic setting in the locale will be used for case conversion.
  7761. }
  7762. {$IFNDEF LinkDynamically}
  7763. function OCIMultiByteStrCaseConversion(envhp:Pdvoid; dststr:POraText; srcstr:POraText; flag:ub4):size_t;cdecl;external ocilib name 'OCIMultiByteStrCaseConversion';
  7764. {$ELSE}
  7765. OCIMultiByteStrCaseConversion : function (envhp:Pdvoid; dststr:POraText; srcstr:POraText; flag:ub4):size_t;cdecl;
  7766. {$ENDIF}
  7767. {------------------------- OCICharSetToUnicode ----------------------------- }
  7768. {
  7769. NAME
  7770. OCICharSetToUnicode - convert multibyte string into Unicode as UCS2
  7771. REMARKS
  7772. This function converts a multi-byte string pointed to by src to Unicode
  7773. into the array pointed to by dst. The conversion will stop when it reach
  7774. to the source limitation or destination limitation.
  7775. The function will return number of characters converted into Unicode.
  7776. If dstlen is zero, it will just return the number of characters for the
  7777. result without real conversion.
  7778. RETURNS
  7779. OCI_SUCCESS, OCI_INVALID_HANDLE or OCI_ERROR
  7780. envhp(IN/OUT)
  7781. Pointer to an OCI environment handle
  7782. dst(OUT)
  7783. Pointer to a destination buffer
  7784. dstlen(IN)
  7785. Size of destination buffer in character
  7786. src(IN)
  7787. Pointer to multi-byte source string.
  7788. srclen(IN)
  7789. Size of source string in bytes.
  7790. rsize(OUT)
  7791. Number of characters converted.
  7792. If it is a NULL pointer, nothing to return.
  7793. }
  7794. {$IFNDEF LinkDynamically}
  7795. function OCICharSetToUnicode(envhp:Pdvoid; dst:Pub2; dstlen:size_t; src:POraText; srclen:size_t;
  7796. rsize:Psize_t):sword;cdecl;external ocilib name 'OCICharSetToUnicode';
  7797. {$ELSE}
  7798. OCICharSetToUnicode : function (envhp:Pdvoid; dst:Pub2; dstlen:size_t; src:POraText; srclen:size_t;
  7799. rsize:Psize_t):sword;cdecl;
  7800. {$ENDIF}
  7801. {------------------------- OCIUnicodeToCharSet ----------------------------- }
  7802. {
  7803. NAME
  7804. OCIUnicodeToCharSet - convert Unicode into multibyte
  7805. REMARKS
  7806. This function converts a Unicode string pointed to by src to multi-byte
  7807. into the array pointed to by dst. The conversion will stop when it reach
  7808. to the source limitation or destination limitation. The function will
  7809. return number of bytes converted into multi-byte. If dstlen is zero, it
  7810. will just return the number of bytes for the result without real
  7811. conversion. If a Unicode character is not convertible for the character
  7812. set specified in OCI environment handle, a replacement character will be
  7813. used for it. In this case, OCICharSetConversionIsReplacementUsed() will
  7814. return ture.
  7815. RETURNS
  7816. OCI_SUCCESS, OCI_INVALID_HANDLE or OCI_ERROR
  7817. envhp(IN/OUT)
  7818. Pointer to an OCI environment handle.
  7819. dst(OUT)
  7820. Pointer to a destination buffer.
  7821. dstlen(IN)
  7822. Size of destination buffer in byte.
  7823. src(IN)
  7824. Pointer to a Unicode string.
  7825. srclen(IN)
  7826. Size of source string in characters.
  7827. rsize(OUT)
  7828. Number of bytes converted.
  7829. If it is a NULL pointer, nothing to return.
  7830. }
  7831. {$IFNDEF LinkDynamically}
  7832. function OCIUnicodeToCharSet(envhp:Pdvoid; dst:POraText; dstlen:size_t; src:Pub2; srclen:size_t;
  7833. rsize:Psize_t):sword;cdecl;external ocilib name 'OCIUnicodeToCharSet';
  7834. {$ELSE}
  7835. OCIUnicodeToCharSet : function (envhp:Pdvoid; dst:POraText; dstlen:size_t; src:Pub2; srclen:size_t;
  7836. rsize:Psize_t):sword;cdecl;
  7837. {$ENDIF}
  7838. {----------------------- OCINlsCharSetConvert ------------------------------ }
  7839. {
  7840. NAME
  7841. OCINlsCharSetConvert - convert between any two character set.
  7842. REMARKS
  7843. This function converts a string pointed to by src in the character set
  7844. specified with srcid to the array pointed to by dst in the character set
  7845. specified with dstid. The conversion will stop when it reaches the source
  7846. limitation or destination limitation. The function will return the number
  7847. of bytes converted into the destination buffer. Even though either source
  7848. or destination character set id is OCI_UTF16ID, given and return data
  7849. length will be represented with the byte length as this function is
  7850. intended for generic purpose. Note the conversion will not stop at null
  7851. data.
  7852. To get character set id from name, OCINlsCharSetNameToId can be used.
  7853. To check if derived data in the destination buffer contains any
  7854. replacement character resulting from conversion failure,
  7855. OCICharSetConversionIsReplacementUsed can be used to get the status.
  7856. Data alignment should be guaranteed by a caller. For example, UTF-16 data
  7857. should be aligned to ub2 type.
  7858. RETURNS
  7859. OCI_SUCCESS or OCI_ERROR.
  7860. errhp(IN/OUT)
  7861. OCI error handle. If there is an error, it is recorded in errhp and this
  7862. function returns a NULL pointer. Diagnostic information can be obtained
  7863. by calling OCIErrorGet().
  7864. dstid(IN)
  7865. Character set id for the destination buffer.
  7866. dstp(OUT)
  7867. Pointer to the destination buffer.
  7868. dstlen(IN)
  7869. The maximum byte size of destination buffer.
  7870. srcid(IN)
  7871. Character set id for the source buffer.
  7872. srcp(IN)
  7873. Pointer to the source buffer.
  7874. srclen(IN)
  7875. The length byte size of source buffer.
  7876. rsize(OUT)
  7877. The number of characters converted. If it is a NULL pointer, nothing to
  7878. return.
  7879. }
  7880. {$IFNDEF LinkDynamically}
  7881. function OCINlsCharSetConvert(envhp:Pdvoid; errhp:POCIError; dstid:ub2; dstp:Pdvoid; dstlen:size_t;
  7882. srcid:ub2; srcp:Pdvoid; srclen:size_t; rsize:Psize_t):sword;cdecl;external ocilib name 'OCINlsCharSetConvert';
  7883. {$ELSE}
  7884. OCINlsCharSetConvert : function (envhp:Pdvoid; errhp:POCIError; dstid:ub2; dstp:Pdvoid; dstlen:size_t;
  7885. srcid:ub2; srcp:Pdvoid; srclen:size_t; rsize:Psize_t):sword;cdecl;
  7886. {$ENDIF}
  7887. { ------------------- OCICharsetConversionIsReplacementUsed ---------------- }
  7888. {
  7889. NAME
  7890. OCICharsetConversionIsReplacementUsed - chech if replacement is used in
  7891. conversion
  7892. REMARKS
  7893. This function indicates whether or not the replacement character was used
  7894. for nonconvertible characters in character set conversion in last invoke
  7895. of OCICharsetUcs2ToMb().
  7896. RETURNS
  7897. TRUE is the replacement character was used in last OCICharsetUcs2ToMb()
  7898. invoking, else FALSE.
  7899. envhp(IN/OUT)
  7900. OCI environment handle. This should be the first handle passed to
  7901. OCICharsetUcs2ToMb().
  7902. }
  7903. {$IFNDEF LinkDynamically}
  7904. function OCICharSetConversionIsReplacementUsed(envhp:Pdvoid):boolean;cdecl;external ocilib name 'OCICharSetConversionIsReplacementUsed';
  7905. {$ELSE}
  7906. OCICharSetConversionIsReplacementUsed : function (envhp:Pdvoid):boolean;cdecl;
  7907. {$ENDIF}
  7908. {------------------- OCINlsEnvironmentVariableGet ----------------- }
  7909. {
  7910. NAME
  7911. OCINlsEnvironmentVariableGet - get a value of NLS environment variable.
  7912. DESCRIPTION
  7913. This function retrieves a value of NLS environment variable to the buffer
  7914. pointed to by val. Data type is determined by the parameter specified by
  7915. item. Either numeric data or string data can be retrieved.
  7916. RETURNS
  7917. OCI_SUCCESS or OCI_ERROR.
  7918. PARAMETERS
  7919. valp(OUT) -
  7920. Pointer to the buffer.
  7921. size(IN) -
  7922. Size of the buffer. This argument is only applicable to string data type,
  7923. but not to numerical data, in such case, it is ignored.
  7924. item(IN) -
  7925. NLS item value, which can be one of following values:
  7926. OCI_NLS_CHARSET_ID - NLS_LANG character set id in ub2 data type.
  7927. OCI_NLS_NCHARSET_ID - NLS_NCHAR character set id in ub2 data type.
  7928. charset(IN) -
  7929. Character set id for retrieved string data. If it is 0, NLS_LANG will be
  7930. used. OCI_UTF16ID is a valid id. In case of numeric data, this argument
  7931. is ignored.
  7932. rsize(OUT) -
  7933. Size of return value.
  7934. NOTE
  7935. This functions is mainly used for retrieving character set id from either
  7936. NLS_LANG or NLS_NCHAR environment variables. If NLS_LANG is not set,
  7937. the default character set id is returned.
  7938. For future extension, the buffer is capable for storing other data types.
  7939. }
  7940. {$IFNDEF LinkDynamically}
  7941. function OCINlsEnvironmentVariableGet(valp:Pdvoid; size:size_t; item:ub2; charset:ub2; rsize:Psize_t):sword;cdecl;external ocilib name 'OCINlsEnvironmentVariableGet';
  7942. {$ELSE}
  7943. OCINlsEnvironmentVariableGet : function (valp:Pdvoid; size:size_t; item:ub2; charset:ub2; rsize:Psize_t):sword;cdecl;
  7944. {$ENDIF}
  7945. {------------------------- OCIMessageOpen ---------------------------------- }
  7946. {
  7947. NAME
  7948. OCIMessageOpen - open a locale message file
  7949. REMARKS
  7950. This function opens a message handle for facility of product in a language
  7951. pointed to by envhp. It first try to open the message file corresponding
  7952. to envhp for the facility. If it successes, it will use that file to
  7953. initialize a message handle, else it will use the default message file
  7954. which is for American language for the facility. The function return a
  7955. pointer pointed to a message handle into msghp parameter.
  7956. RETURNS
  7957. OCI_SUCCESS, OCI_INVALID_HANDLE or OCI_ERROR
  7958. envhp(IN/OUT)
  7959. A pointer to OCI environment handle for message language.
  7960. errhp(IN/OUT)
  7961. The OCI error handle. If there is an error, it is record in errhp and this
  7962. function returns a NULL pointer. Diagnostic information can be obtained by
  7963. calling OCIErrorGet().
  7964. msghp(OUT)
  7965. a message handle for return
  7966. product(IN)
  7967. A pointer to a product name. Product name is used to locate the directory
  7968. for message in a system dependent way. For example, in Solaris, the
  7969. directory of message files for the product `rdbms' is
  7970. `$ORACLE_HOME/rdbms'.
  7971. facility(IN)
  7972. A pointer to a facility name in the product. It is used to construct a
  7973. message file name. A message file name follows the conversion with
  7974. facility as prefix. For example, the message file name for facility
  7975. `img' in American language will be `imgus.msb' where `us' is the
  7976. abbreviation of American language and `msb' as message binary file
  7977. extension.
  7978. dur(IN)
  7979. Duration for memory allocation for the return message handle. It can be
  7980. the following values:
  7981. OCI_DURATION_CALL
  7982. OCI_DURATION_STATEMENT
  7983. OCI_DURATION_SESSION
  7984. OCI_DURATION_TRANSACTION
  7985. For the detail description, please refer to Memory Related Service
  7986. Interfaces section.
  7987. }
  7988. {$IFNDEF LinkDynamically}
  7989. function OCIMessageOpen(envhp:Pdvoid; errhp:POCIError; var msghp:POCIMsg; product:POraText; facility:POraText;
  7990. dur:OCIDuration):sword;cdecl;external ocilib name 'OCIMessageOpen';
  7991. {$ELSE}
  7992. OCIMessageOpen : function (envhp:Pdvoid; errhp:POCIError; var msghp:POCIMsg; product:POraText; facility:POraText;
  7993. dur:OCIDuration):sword;cdecl;
  7994. {$ENDIF}
  7995. {------------------------- OCIMessageGet ----------------------------------- }
  7996. {
  7997. NAME
  7998. OCIMessageGet - get a locale message from a message handle
  7999. REMARKS
  8000. This function will get message with message number identified by msgno and
  8001. if buflen is not zero, the function will copy the message into the buffer
  8002. pointed to by msgbuf. If buflen is zero, the message will be copied into
  8003. a message buffer inside the message handle pointed to by msgh. For both
  8004. cases. it will return the pointer to the null-terminated message string.
  8005. If it cannot get the message required, it will return a NULL pointer.
  8006. RETURNS
  8007. A pointer to a null-terminated message string on success, otherwise a NULL
  8008. pointer.
  8009. msgh(IN/OUT)
  8010. Pointer to a message handle which was previously opened by
  8011. OCIMessageOpen().
  8012. msgno(IN)
  8013. The message number for getting message.
  8014. msgbuf(OUT)
  8015. Pointer to a destination buffer to the message retrieved. If buflen is
  8016. zero, it can be NULL pointer.
  8017. buflen(IN)
  8018. The size of the above destination buffer.
  8019. }
  8020. {$IFNDEF LinkDynamically}
  8021. function OCIMessageGet(msgh:POCIMsg; msgno:ub4; msgbuf:POraText; buflen:size_t):POraText;cdecl;external ocilib name 'OCIMessageGet';
  8022. {$ELSE}
  8023. OCIMessageGet : function (msgh:POCIMsg; msgno:ub4; msgbuf:POraText; buflen:size_t):POraText;cdecl;
  8024. {$ENDIF}
  8025. {------------------------- OCIMessageClose --------------------------------- }
  8026. {
  8027. NAME
  8028. OCIMessageClose - close a message handle
  8029. REMARKS
  8030. This function closes a message handle pointed to by msgh and frees any
  8031. memory associated with this handle.
  8032. RETURNS
  8033. OCI_SUCCESS, OCI_INVALID_HANDLE or OCI_ERROR
  8034. envhp(IN/OUT)
  8035. A pointer to OCI environment handle for message language.
  8036. errhp(IN/OUT)
  8037. The OCI error handle. If there is an error, it is record in errhp and this
  8038. function returns a NULL pointer. Diagnostic information can be obtained by
  8039. calling OCIErrorGet().
  8040. msghp(IN/OUT)
  8041. A pointer to a message handle which was previously opened by
  8042. OCIMessageOpen().
  8043. }
  8044. {$IFNDEF LinkDynamically}
  8045. function OCIMessageClose(envhp:Pdvoid; errhp:POCIError; msghp:POCIMsg):sword;cdecl;external ocilib name 'OCIMessageClose';
  8046. {$ELSE}
  8047. OCIMessageClose : function (envhp:Pdvoid; errhp:POCIError; msghp:POCIMsg):sword;cdecl;
  8048. {$ENDIF}
  8049. {--------------- End of Extensions to NLS cartridge service ---------------- }
  8050. {----------------- Extensions to OCI Thread interface --------------------- }
  8051. {****************************************************************************
  8052. DESCRIPTION
  8053. ******************************************************************************
  8054. 1 Threads Interface
  8055. The OCIThread package provides a number of commonly used threading
  8056. primitives for use by Oracle customers. It offers a portable interface to
  8057. threading capabilities native to various platforms. It does not implement
  8058. threading on platforms which do not have native threading capability.
  8059. OCIThread does not provide a portable implementation of multithreaded
  8060. facilities. It only serves as a set of portable covers for native
  8061. multithreaded facilities. Therefore, platforms that do not have native
  8062. support for multi-threading will only be able to support a limited
  8063. implementation of OCIThread. As a result, products that rely on all of
  8064. OCIThread's functionality will not port to all platforms. Products that must
  8065. port to all platforms must use only a subset of OCIThread's functionality.
  8066. This issue is discussed further in later sections of this document.
  8067. The OCIThread API is split into four main parts. Each part is described
  8068. briefly here. The following subsections describe each in greater detail.
  8069. 1. Initialization and Termination Calls
  8070. These calls deal with the initialization and termination of OCIThread.
  8071. Initialization of OCIThread initializes the OCIThread context which is
  8072. a member of the OCI environment or session handle. This context is
  8073. required for other OCIThread calls.
  8074. 2. Passive Threading Primitives
  8075. The passive threading primitives include primitives to manipulate mutual
  8076. exclusion (mutex) locks, thread ID's, and thread-specific data keys.
  8077. The reason that these primitives are described as 'passive' is that while
  8078. their specifications allow for the existence of multiple threads, they do
  8079. not require it. This means that it is possible for these primitives to
  8080. be implemented according to specification in both single-threaded and
  8081. multi-threaded environments.
  8082. As a result, OCIThread clients that use only these primitives will not
  8083. require the existence of multiple threads in order to work correctly,
  8084. i.e., they will be able to work in single-threaded environments without
  8085. branching code.
  8086. 3. Active Threading Primitives
  8087. Active threading primitives include primitives dealing with the creation,
  8088. termination, and other manipulation of threads.
  8089. The reason that these primitives are described as 'active' is that they
  8090. can only be used in true multi-threaded environments. Their
  8091. specifications explicitly require that it be possible to have multiple
  8092. threads. If you need to determine at runtime whether or not you are in a
  8093. multi-threaded environment, call OCIThreadIsMulti() before calling an
  8094. OCIThread active primitive.
  8095. 1.1 Initialization & Termination
  8096. ==================================
  8097. The types and functions described in this section are associated with the
  8098. initialization and termination of the OCIThread package. OCIThread must
  8099. be properly initialized before any of its functionality can be used.
  8100. OCIThread's process initialization function, 'OCIThreadProcessInit()',
  8101. must be called with care; see below.
  8102. The observed behavior of the initialization and termination functions is the
  8103. same regardless of whether OCIThread is in single-threaded or multi-threaded
  8104. environment. It is OK to call the initialization functions from both generic
  8105. and operating system specific (OSD) code.
  8106. 1.1.1 Types
  8107. OCIThreadContext - OCIThread Context
  8108. -------------------------------------
  8109. Most calls to OCIThread functions take the OCI environment or session
  8110. handle as a parameter. The OCIThread context is part of the OCI
  8111. environment or session handle and it must be initialized by calling
  8112. 'OCIThreadInit()'. Termination of the OCIThread context occurs by calling
  8113. 'OCIThreadTerm()'.
  8114. The OCIThread context is a private data structure. Clients must NEVER
  8115. attempt to examine the contents of the context.
  8116. 1.1.2 OCIThreadProcessInit
  8117. OCIThreadProcessInit - OCIThread Process INITialization
  8118. --------------------------------------------------------
  8119. Description
  8120. This function should be called to perform OCIThread process
  8121. initialization.
  8122. Prototype
  8123. void OCIThreadProcessInit();
  8124. Returns
  8125. Nothing.
  8126. Notes
  8127. Whether or not this function needs to be called depends on how OCI
  8128. Thread is going to be used.
  8129. * In a single-threaded application, calling this function is optional.
  8130. If it is called at all, the first call to it must occur before calls
  8131. to any other OCIThread functions. Subsequent calls can be made
  8132. without restriction; they will not have any effect.
  8133. * In a multi-threaded application, this function MUST be called. The
  8134. first call to it MUST occur 'strictly before' any other OCIThread
  8135. calls; i.e., no other calls to OCIThread functions (including other
  8136. calls to this one) can be concurrent with the first call.
  8137. Subsequent calls to this function can be made without restriction;
  8138. they will not have any effect.
  8139. 1.1.3 OCIThreadInit
  8140. OCIThreadInit - OCIThread INITialize
  8141. -------------------------------------
  8142. Description
  8143. This initializes OCIThread context.
  8144. Prototype
  8145. sword OCIThreadInit(dvoid *hndl, OCIError *err);
  8146. hndl(IN/OUT): The OCI environment or session handle.
  8147. err(IN/OUT): The OCI error handle. If there is an error and OCI_ERROR
  8148. is returned, the error is recorded in err and diagnostic
  8149. information can be obtained by calling OCIErrorGet().
  8150. Returns
  8151. OCI_SUCCESS, OCI_ERROR or OCI_INVALID_HANDLE.
  8152. Notes
  8153. It is illegal for OCIThread clients to try an examine the memory
  8154. pointed to by the returned pointer.
  8155. It is safe to make concurrent calls to 'OCIThreadInit()'. Unlike
  8156. 'OCIThreadProcessInit()', there is no need to have a first call
  8157. that occurs before all the others.
  8158. The first time 'OCIThreadInit()' is called, it initilaizes the OCI
  8159. Thread context. It also saves a pointer to the context in some system
  8160. dependent manner. Subsequent calls to 'OCIThreadInit()' will return
  8161. the same context.
  8162. Each call to 'OCIThreadInit()' must eventually be matched by a call to
  8163. 'OCIThreadTerm()'.
  8164. OCIThreadTerm - OCIThread TERMinate
  8165. ------------------------------------
  8166. Description
  8167. This should be called to release the OCIThread context. It should be
  8168. called exactly once for each call made to 'OCIThreadInit()'.
  8169. Prototype
  8170. sword OCIThreadTerm(dvoid *hndl, OCIError *err);
  8171. hndl(IN/OUT): The OCI environment or session handle.
  8172. err(IN/OUT): The OCI error handle. If there is an error and OCI_ERROR
  8173. is returned, the error is recorded in err and diagnostic
  8174. information can be obtained by calling OCIErrorGet().
  8175. Returns
  8176. OCI_SUCCESS, OCI_ERROR or OCI_INVALID_HANDLE.
  8177. Notes
  8178. It is safe to make concurrent calls to 'OCIThreadTerm()'.
  8179. 'OCIThreadTerm()' will not do anything until it has been called as
  8180. many times as 'OCIThreadInit()' has been called. When that happens,
  8181. it terminates the OCIThread layer and frees the memory allocated for
  8182. the context. Once this happens, the context should not be re-used.
  8183. It will be necessary to obtain a new one by calling 'OCIThreadInit()'.
  8184. OCIThreadIsMulti - OCIThread Is Multi-Threaded?
  8185. ------------------------------------------------
  8186. Description
  8187. This tells the caller whether the application is running in a
  8188. multi-threaded environment or a single-threaded environment.
  8189. Prototype
  8190. boolean OCIThreadIsMulti(void);
  8191. Returns
  8192. TRUE if the environment is multi-threaded;
  8193. FALSE if the environment is single-threaded.
  8194. 1.2 Passive Threading Primitives
  8195. ==================================
  8196. 1.2.1 Types
  8197. The passive threading primitives deal with the manipulation of mutex,
  8198. thread ID's, and thread-specific data. Since the specifications of these
  8199. primitives do not require the existence of multiple threads, they can be
  8200. used both on multithreaded and single-threaded platforms.
  8201. 1.2.1.1 OCIThreadMutex - OCIThread Mutual Exclusion Lock
  8202. -----------------------------------------------------------
  8203. The type 'OCIThreadMutex' is used to represent a mutual exclusion lock
  8204. (mutex). A mutex is typically used for one of two purposes: (i) to
  8205. ensure that only one thread accesses a given set of data at a time, or
  8206. (ii) to ensure that only one thread executes a given critical section of
  8207. code at a time.
  8208. Mutexes pointer can be declared as parts of client structures or as
  8209. stand-alone variables. Before they can be used, they must be initialized
  8210. using 'OCIThreadMutexInit()'. Once they are no longer needed, they must be
  8211. destroyed using 'OCIThreadMutexDestroy()'. A mutex pointer must NOT be
  8212. used after it is destroyed.
  8213. A thread can acquire a mutex by using either 'OCIThreadMutexAcquire()' or
  8214. 'OCIThreadMutexTry()'. They both ensure that only one thread at a time is
  8215. allowed to hold a given mutex. A thread that holds a mutex can release it
  8216. by calling 'OCIThreadMutexRelease()'.
  8217. 1.2.1.2 OCIThreadKey - OCIThread Key for Thread-Specific Data
  8218. ----------------------------------------------------------------
  8219. A key can be thought of as a process-wide variable that has a
  8220. thread-specific value. What this means is that all the threads in a
  8221. process can use any given key. However, each thread can examine or modify
  8222. that key independently of the other threads. The value that a thread sees
  8223. when it examines the key will always be the same as the value that it last
  8224. set for the key. It will not see any values set for the key by the other
  8225. threads.
  8226. The type of the value held by a key is a 'dvoid *' generic pointer.
  8227. Keys can be created using 'OCIThreadKeyInit()'. When a key is created, its
  8228. value is initialized to 'NULL' for all threads.
  8229. A thread can set a key's value using 'OCIThreadKeySet()'. A thread can
  8230. get a key's value using 'OCIThreadKeyGet()'.
  8231. The OCIThread key functions will save and retrieve data SPECIFIC TO THE
  8232. THREAD. When clients maintain a pool of threads and assign the threads to
  8233. different tasks, it *may not* be appropriate for a task to use OCIThread
  8234. key functions to save data associated with it. Here is a scenario of how
  8235. things can fail: A thread is assigned to execute the initialization of a
  8236. task. During the initialization, the task stored some data related to it
  8237. in the thread using OCIThread key functions. After the initialization,
  8238. the thread is returned back to the threads pool. Later, the threads pool
  8239. manager assigned another thread to perform some operations on the task,
  8240. and the task needs to retrieve those data it stored earlier in
  8241. initialization. Since the task is running in another thread, it will not
  8242. be able to retrieve the same data back! Applications that use thread
  8243. pools should be aware of this and be cautious when using OCIThread key
  8244. functions.
  8245. 1.2.1.3 OCIThreadKeyDestFunc - OCIThread Key Destructor Function Type
  8246. ------------------------------------------------------------------------
  8247. This is the type of a pointer to a key's destructor routine. Keys can be
  8248. associated with a destructor routine when they are created (see
  8249. 'OCIThreadKeyInit()').
  8250. A key's destructor routine will be called whenever a thread that has a
  8251. non-NULL value for the key terminates.
  8252. The destructor routine returns nothing and takes one parameter. The
  8253. parameter will be the value that was set for key when the thread
  8254. terminated.
  8255. The destructor routine is guaranteed to be called on a thread's value
  8256. in the key after the termination of the thread and before process
  8257. termination. No more precise guarantee can be made about the timing
  8258. of the destructor routine call; thus no code in the process may assume
  8259. any post-condition of the destructor routine. In particular, the
  8260. destructor is not guaranteed to execute before a join call on the
  8261. terminated thread returns.
  8262. 1.2.1.4 OCIThreadId - OCIThread Thread ID
  8263. --------------------------------------------
  8264. Type 'OCIThreadId' is the type that will be used to identify a thread.
  8265. At any given time, no two threads will ever have the same 'OCIThreadId'.
  8266. However, 'OCIThreadId' values can be recycled; i.e., once a thread dies,
  8267. a new thread may be created that has the same 'OCIThreadId' as the one
  8268. that died. In particular, the thread ID must uniquely identify a thread
  8269. T within a process, and it must be consistent and valid in all threads U
  8270. of the process for which it can be guaranteed that T is running
  8271. concurrently with U. The thread ID for a thread T must be retrievable
  8272. within thread T. This will be done via OCIThreadIdGet().
  8273. The 'OCIThreadId' type supports the concept of a NULL thread ID: the NULL
  8274. thread ID will never be the same as the ID of an actual thread.
  8275. 1.2.2 Function prototypes for passive primitives
  8276. --------------------------------------------------
  8277. 1.2.2.1 Mutex functions
  8278. -------------------------
  8279. OCIThreadMutexInit - OCIThread MuteX Initialize
  8280. -----------------------------------------------
  8281. Description
  8282. This allocate and initializes a mutex. All mutexes must be
  8283. initialized prior to use.
  8284. Prototype
  8285. sword OCIThreadMutexInit(dvoid *hndl, OCIError *err,
  8286. OCIThreadMutex **mutex);
  8287. hndl(IN/OUT): The OCI environment or session handle.
  8288. err(IN/OUT): The OCI error handle. If there is an error and OCI_ERROR
  8289. is returned, the error is recorded in err and diagnostic
  8290. information can be obtained by calling OCIErrorGet().
  8291. mutex(OUT): The mutex to initialize.
  8292. Returns
  8293. OCI_SUCCESS, OCI_ERROR or OCI_INVALID_HANDLE.
  8294. Notes
  8295. Multiple threads must not initialize the same mutex simultaneously.
  8296. Also, a mutex must not be reinitialized until it has been destroyed (see
  8297. 'OCIThreadMutexDestroy()').
  8298. OCIThreadMutexDestroy - OCIThread MuteX Destroy
  8299. -----------------------------------------------
  8300. Description
  8301. This destroys and deallocate a mutex. Each mutex must be destroyed
  8302. once it is no longer needed.
  8303. Prototype
  8304. sword OCIThreadMutexDestroy(dvoid *hndl, OCIError *err,
  8305. OCIThreadMutex **mutex);
  8306. hndl(IN/OUT): The OCI environment or session handle.
  8307. err(IN/OUT): The OCI error handle. If there is an error and OCI_ERROR
  8308. is returned, the error is recorded in err and diagnostic
  8309. information can be obtained by calling OCIErrorGet().
  8310. mutex(IN/OUT): The mutex to destroy.
  8311. Returns
  8312. OCI_SUCCESS, OCI_ERROR or OCI_INVALID_HANDLE.
  8313. Notes
  8314. It is not legal to destroy a mutex that is uninitialized or is currently
  8315. held by a thread. The destruction of a mutex must not occur concurrently
  8316. with any other operations on the mutex. A mutex must not be used after
  8317. it has been destroyed.
  8318. OCIThreadMutexAcquire - OCIThread MuteX Acquire
  8319. -----------------------------------------------
  8320. Description
  8321. This acquires a mutex for the thread in which it is called. If the mutex
  8322. is held by another thread, the calling thread is blocked until it can
  8323. acquire the mutex.
  8324. Prototype
  8325. sword OCIThreadMutexAcquire(dvoid *hndl, OCIError *err,
  8326. OCIThreadMutex *mutex);
  8327. hndl(IN/OUT): The OCI environment or session handle.
  8328. err(IN/OUT): The OCI error handle. If there is an error, it is
  8329. recorded in err and this function returns OCI_ERROR.
  8330. Diagnostic information can be obtained by calling
  8331. OCIErrorGet().
  8332. mutex(IN/OUT): The mutex to acquire.
  8333. Returns
  8334. OCI_SUCCESS, OCI_ERROR or OCI_INVALID_HANDLE.
  8335. Notes
  8336. It is illegal to attempt to acquire an uninitialized mutex.
  8337. This function's behavior is undefined if it is used by a thread to
  8338. acquire a mutex that is already held by that thread.
  8339. OCIThreadMutexRelease - OCIThread MuteX Release
  8340. -----------------------------------------------
  8341. Description
  8342. This releases a mutex. If there are any threads blocked on the mutex,
  8343. one of them will acquire it and become unblocked.
  8344. Prototype
  8345. sword OCIThreadMutexRelease(dvoid *hndl, OCIError *err,
  8346. OCIThreadMutex *mutex);
  8347. hndl(IN/OUT): The OCI environment or session handle.
  8348. err(IN/OUT): The OCI error handle. If there is an error and OCI_ERROR
  8349. is returned, the error is recorded in err and diagnostic
  8350. information can be obtained by calling OCIErrorGet().
  8351. mutex(IN/OUT): The mutex to release.
  8352. Returns
  8353. OCI_SUCCESS, OCI_ERROR or OCI_INVALID_HANDLE.
  8354. Notes
  8355. It is illegal to attempt to release an uninitialized mutex. It is also
  8356. illegal for a thread to release a mutex that it does not hold.
  8357. OCIThreadKeyInit - OCIThread KeY Initialize
  8358. -------------------------------------------
  8359. Description
  8360. This creates a key. Each call to this routine allocate and generates
  8361. a new key that is distinct from all other keys.
  8362. Prototype
  8363. sword OCIThreadKeyInit(dvoid *hndl, OCIError *err, OCIThreadKey **key,
  8364. OCIThreadKeyDestFunc destFn);
  8365. hndl(IN/OUT): The OCI environment or session handle.
  8366. err(IN/OUT): The OCI error handle. If there is an error and OCI_ERROR
  8367. is returned, the error is recorded in err and diagnostic
  8368. information can be obtained by calling OCIErrorGet().
  8369. key(OUT): The 'OCIThreadKey' in which to create the new key.
  8370. destFn(IN): The destructor for the key. NULL is permitted.
  8371. Returns
  8372. OCI_SUCCESS, OCI_ERROR or OCI_INVALID_HANDLE.
  8373. Notes
  8374. Once this function executes successfully, a pointer to an allocated and
  8375. initialized key is return. That key can be used with 'OCIThreadKeyGet()'
  8376. and 'OCIThreadKeySet()'. The initial value of the key will be 'NULL' for
  8377. all threads.
  8378. It is illegal for this function to be called more than once to create the
  8379. same key (i.e., to be called more than once with the same value for the
  8380. 'key' parameter).
  8381. If the 'destFn' parameter is not NULL, the routine pointed to by 'destFn'
  8382. will be called whenever a thread that has a non-NULL value for the key
  8383. terminates. The routine will be called with one parameter. The
  8384. parameter will be the key's value for the thread at the time at which the
  8385. thread terminated.
  8386. If the key does not need a destructor function, pass NULL for 'destFn'.
  8387. OCIThreadKeyDestroy - OCIThread KeY DESTROY
  8388. -------------------------------------------
  8389. Description
  8390. Destroy and deallocate the key pointed to by 'key'.
  8391. Prototype
  8392. sword OCIThreadKeyDestroy(dvoid *hndl, OCIError *err,
  8393. OCIThreadKey **key);
  8394. hndl(IN/OUT): The OCI environment or session handle.
  8395. err(IN/OUT): The OCI error handle. If there is an error and OCI_ERROR
  8396. is returned, the error is recorded in err and diagnostic
  8397. information can be obtained by calling OCIErrorGet().
  8398. key(IN/OUT): The 'OCIThreadKey' in which to destroy the key.
  8399. Returns
  8400. OCI_SUCCESS, OCI_ERROR or OCI_INVALID_HANDLE.
  8401. Notes
  8402. This is different from the destructor function callback passed to the
  8403. key create routine. This new destroy function 'OCIThreadKeyDestroy' is
  8404. used to terminate any resources OCI THREAD acquired when it created
  8405. 'key'. [The 'OCIThreadKeyDestFunc' callback type is a key VALUE
  8406. destructor; it does in no way operate on the key itself.]
  8407. This must be called once the user has finished using the key. Not
  8408. calling the key destroy function may result in memory leaks.
  8409. 1.2.2.2 Thread Key operations
  8410. -------------------------------
  8411. OCIThreadKeyGet - OCIThread KeY Get value
  8412. -----------------------------------------
  8413. Description
  8414. This gets the calling thread's current value for a key.
  8415. Prototype
  8416. sword OCIThreadKeyGet(dvoid *hndl, OCIError *err, OCIThreadKey *key,
  8417. dvoid **pValue);
  8418. hndl(IN/OUT): The OCI environment or session handle.
  8419. err(IN/OUT): The OCI error handle. If there is an error and OCI_ERROR
  8420. is returned, the error is recorded in err and diagnostic
  8421. information can be obtained by calling OCIErrorGet().
  8422. key(IN): The key.
  8423. pValue(IN/OUT): The location in which to place the thread-specific
  8424. key value.
  8425. Returns
  8426. OCI_SUCCESS, OCI_ERROR or OCI_INVALID_HANDLE.
  8427. Notes
  8428. It is illegal to use this function on a key that has not been created
  8429. using 'OCIThreadKeyInit()'.
  8430. If the calling thread has not yet assigned a value to the key, 'NULL' is
  8431. placed in the location pointed to by 'pValue'.
  8432. OCIThreadKeySet - OCIThread KeY Set value
  8433. -----------------------------------------
  8434. Description
  8435. This sets the calling thread's value for a key.
  8436. Prototype
  8437. sword OCIThreadKeySet(dvoid *hndl, OCIError *err, OCIThreadKey *key,
  8438. dvoid *value);
  8439. hndl(IN/OUT): The OCI environment or session handle.
  8440. err(IN/OUT): The OCI error handle. If there is an error and OCI_ERROR
  8441. is returned, the error is recorded in err and diagnostic
  8442. information can be obtained by calling OCIErrorGet().
  8443. key(IN/OUT): The key.
  8444. value(IN): The thread-specific value to set in the key.
  8445. Returns
  8446. OCI_SUCCESS, OCI_ERROR or OCI_INVALID_HANDLE.
  8447. Notes
  8448. It is illegal to use this function on a key that has not been created
  8449. using 'OCIThreadKeyInit()'.
  8450. 1.2.2.3 Thread Id
  8451. --------------------
  8452. OCIThreadIdInit - OCIThread Thread Id INITialize
  8453. --------------------------------------------------
  8454. Description
  8455. Allocate and initialize the thread id 'tid'.
  8456. Prototype
  8457. sword OCIThreadIdInit(dvoid *hndl, OCIError *err, OCIThreadId **tid);
  8458. hndl(IN/OUT): The OCI environment or session handle.
  8459. err(IN/OUT): The OCI error handle. If there is an error and OCI_ERROR
  8460. is returned, the error is recorded in err and diagnostic
  8461. information can be obtained by calling OCIErrorGet().
  8462. tid (OUT): Pointer to the thread ID to initialize.
  8463. Returns
  8464. OCI_SUCCESS, OCI_ERROR or OCI_INVALID_HANDLE.
  8465. OCIThreadIdDestroy - OCIThread Thread Id DESTROY
  8466. --------------------------------------------------
  8467. Description
  8468. Destroy and deallocate the thread id 'tid'.
  8469. Prototype
  8470. sword OCIThreadIdDestroy(dvoid *hndl, OCIError *err, OCIThreadId **tid);
  8471. hndl(IN/OUT): The OCI environment or session handle.
  8472. err(IN/OUT): The OCI error handle. If there is an error and OCI_ERROR
  8473. is returned, the error is recorded in err and diagnostic
  8474. information can be obtained by calling OCIErrorGet().
  8475. tid(IN/OUT): Pointer to the thread ID to destroy.
  8476. Returns
  8477. OCI_SUCCESS, OCI_ERROR or OCI_INVALID_HANDLE.
  8478. Note
  8479. 'tid' should be initialized by OCIThreadIdInit().
  8480. OCIThreadIdSet - OCIThread Thread Id Set
  8481. -----------------------------------------
  8482. Description
  8483. This sets one 'OCIThreadId' to another.
  8484. Prototype
  8485. sword OCIThreadIdSet(dvoid *hndl, OCIError *err,
  8486. OCIThreadId *tidDest,
  8487. OCIThreadId *tidSrc);
  8488. hndl(IN/OUT): The OCI environment or session handle.
  8489. err(IN/OUT): The OCI error handle. If there is an error and OCI_ERROR
  8490. is returned, the error is recorded in err and diagnostic
  8491. information can be obtained by calling OCIErrorGet().
  8492. tidDest(OUT): This should point to the location of the 'OCIThreadId'
  8493. to be set to.
  8494. tidSrc(IN): This should point to the 'OCIThreadId' to set from.
  8495. Returns
  8496. OCI_SUCCESS, OCI_ERROR or OCI_INVALID_HANDLE.
  8497. Notes
  8498. 'tid' should be initialized by OCIThreadIdInit().
  8499. OCIThreadIdSetNull - OCIThread Thread Id Set Null
  8500. ---------------------------------------------------------
  8501. Description
  8502. This sets the NULL thread ID to a given 'OCIThreadId'.
  8503. Prototype
  8504. sword OCIThreadIdSetNull(dvoid *hndl, OCIError *err,
  8505. OCIThreadId *tid);
  8506. hndl(IN/OUT): The OCI environment or session handle.
  8507. err(IN/OUT): The OCI error handle. If there is an error, it is
  8508. recorded in err and this function returns OCI_ERROR.
  8509. Diagnostic information can be obtained by calling
  8510. OCIErrorGet().
  8511. tid(OUT): This should point to the 'OCIThreadId' in which to put
  8512. the NULL thread ID.
  8513. Returns
  8514. OCI_SUCCESS, OCI_ERROR or OCI_INVALID_HANDLE.
  8515. Notes
  8516. 'tid' should be initialized by OCIThreadIdInit().
  8517. OCIThreadIdGet - OCIThread Thread Id Get
  8518. ------------------------------------------
  8519. Description
  8520. This retrieves the 'OCIThreadId' of the thread in which it is called.
  8521. Prototype
  8522. sword OCIThreadIdGet(dvoid *hndl, OCIError *err,
  8523. OCIThreadId *tid);
  8524. hndl(IN/OUT): The OCI environment or session handle.
  8525. err(IN/OUT): The OCI error handle. If there is an error and OCI_ERROR
  8526. is returned, the error is recorded in err and diagnostic
  8527. information can be obtained by calling OCIErrorGet().
  8528. tid(OUT): This should point to the location in which to place the
  8529. ID of the calling thread.
  8530. Returns
  8531. OCI_SUCCESS, OCI_ERROR or OCI_INVALID_HANDLE.
  8532. Notes
  8533. 'tid' should be initialized by OCIThreadIdInit().
  8534. When OCIThread is used in a single-threaded environment,
  8535. OCIThreadIdGet() will always place the same value in the location
  8536. pointed to by 'tid'. The exact value itself is not important. The
  8537. important thing is that it is not the same as the NULL thread ID and
  8538. that it is always the same value.
  8539. OCIThreadIdSame - OCIThread Thread Ids Same?
  8540. ----------------------------------------------
  8541. Description
  8542. This determines whether or not two 'OCIThreadId's represent the same
  8543. thread.
  8544. Prototype
  8545. sword OCIThreadIdSame(dvoid *hndl, OCIError *err,
  8546. OCIThreadId *tid1, OCIThreadId *tid2,
  8547. boolean *result);
  8548. hndl(IN/OUT): The OCI environment or session handle.
  8549. err(IN/OUT): The OCI error handle. If there is an error and OCI_ERROR
  8550. is returned, the error is recorded in err and diagnostic
  8551. information can be obtained by calling OCIErrorGet().
  8552. tid1(IN): Pointer to the first 'OCIThreadId'.
  8553. tid2(IN): Pointer to the second 'OCIThreadId'.
  8554. result(IN/OUT): Pointer to the result.
  8555. Returns
  8556. OCI_SUCCESS, OCI_ERROR or OCI_INVALID_HANDLE.
  8557. Notes
  8558. If 'tid1' and 'tid2' represent the same thread, 'result' is set to TRUE.
  8559. Otherwise, 'result' is set to FALSE.
  8560. 'result' is set to TRUE if both 'tid1' and 'tid2' are the NULL thread ID.
  8561. 'ti1d' and 'tid2' should be initialized by OCIThreadIdInit().
  8562. OCIThreadIdNull - OCIThread Thread Id NULL?
  8563. ---------------------------------------------
  8564. Description
  8565. This determines whether or not a given 'OCIThreadId' is the NULL thread
  8566. ID.
  8567. Prototype
  8568. sword OCIThreadIdNull(dvoid *hndl, OCIError *err,
  8569. OCIThreadId *tid,
  8570. boolean *result);
  8571. hndl(IN/OUT): The OCI environment or session handle.
  8572. err(IN/OUT): The OCI error handle. If there is an error and OCI_ERROR
  8573. is returned, the error is recorded in err and diagnostic
  8574. information can be obtained by calling OCIErrorGet().
  8575. tid(IN): Pointer to the 'OCIThreadId' to check.
  8576. result(IN/OUT): Pointer to the result.
  8577. Returns
  8578. OCI_SUCCESS, OCI_ERROR or OCI_INVALID_HANDLE.
  8579. Notes
  8580. If 'tid' is the NULL thread ID, 'result' is set to TRUE. Otherwise,
  8581. 'result' is set to FALSE.
  8582. 'tid' should be initialized by OCIThreadIdInit().
  8583. 1.3 Active Threading Primitives
  8584. =================================
  8585. The active threading primitives deal with the manipulation of actual
  8586. threads. Because the specifications of most of these primitives require
  8587. that it be possible to have multiple threads, they work correctly only in
  8588. the enabled OCIThread; In the disabled OCIThread, they always return
  8589. failure. The exception is OCIThreadHandleGet(); it may be called in a
  8590. single-threaded environment, in which case it will have no effect.
  8591. Active primitives should only be called by code running in a multi-threaded
  8592. environment. You can call OCIThreadIsMulti() to determine whether the
  8593. environment is multi-threaded or single-threaded.
  8594. 1.3.1 Types
  8595. --------------
  8596. 1.3.1.1 OCIThreadHandle - OCIThread Thread Handle
  8597. ------------------------------------------------------
  8598. Type 'OCIThreadHandle' is used to manipulate a thread in the active
  8599. primitives: OCIThreadJoin()and OCIThreadClose(). A thread handle opened by
  8600. OCIThreadCreate() must be closed in a matching call to
  8601. OCIThreadClose(). A thread handle is invalid after the call to
  8602. OCIThreadClose().
  8603. The distinction between a thread ID and a thread handle in OCIThread usage
  8604. follows the distinction between the thread ID and the thread handle on
  8605. Windows NT. On many platforms, the underlying native types are the same.
  8606. 1.3.2 Functions
  8607. ------------------
  8608. OCIThreadHndInit - OCIThread HaNDle Initialize
  8609. ----------------------------------------------
  8610. Description
  8611. Allocate and initialize the thread handle.
  8612. Prototype
  8613. sword OCIThreadHndInit(dvoid *hndl, OCIError *err,
  8614. OCIThreadHandle **thnd);
  8615. hndl(IN/OUT): The OCI environment or session handle.
  8616. err(IN/OUT): The OCI error handle. If there is an error and OCI_ERROR
  8617. is returned, the error is recorded in err and diagnostic
  8618. information can be obtained by calling OCIErrorGet().
  8619. thnd(OUT): The address of pointer to the thread handle to initialize.
  8620. Returns
  8621. OCI_SUCCESS, OCI_ERROR or OCI_INVALID_HANDLE.
  8622. OCIThreadHndDestroy - OCIThread HaNDle Destroy
  8623. ----------------------------------------------
  8624. Description
  8625. Destroy and deallocate the thread handle.
  8626. Prototype
  8627. sword OCIThreadHndDestroy(dvoid *hndl, OCIError *err,
  8628. OCIThreadHandle **thnd);
  8629. hndl(IN/OUT): The OCI environment or session handle.
  8630. err(IN/OUT): The OCI error handle. If there is an error and OCI_ERROR
  8631. is returned, the error is recorded in err and diagnostic
  8632. information can be obtained by calling OCIErrorGet().
  8633. thnd(IN/OUT): The address of pointer to the thread handle to destroy.
  8634. Returns
  8635. OCI_SUCCESS, OCI_ERROR or OCI_INVALID_HANDLE.
  8636. Notes
  8637. 'thnd' should be initialized by OCIThreadHndInit().
  8638. OCIThreadCreate - OCIThread Thread Create
  8639. -----------------------------------------
  8640. Description
  8641. This creates a new thread.
  8642. Prototype
  8643. sword OCIThreadCreate(dvoid *hndl, OCIError *err,
  8644. void (*start)(dvoid *), dvoid *arg,
  8645. OCIThreadId *tid, OCIThreadHandle *tHnd);
  8646. hndl(IN/OUT): The OCI environment or session handle.
  8647. err(IN/OUT): The OCI error handle. If there is an error and OCI_ERROR
  8648. is returned, the error is recorded in err and diagnostic
  8649. information can be obtained by calling OCIErrorGet().
  8650. start(IN): The function in which the new thread should begin
  8651. execution.
  8652. arg(IN): The argument to give the function pointed to by 'start'.
  8653. tid(IN/OUT): If not NULL, gets the ID for the new thread.
  8654. tHnd(IN/OUT): If not NULL, gets the handle for the new thread.
  8655. Returns
  8656. OCI_SUCCESS, OCI_ERROR or OCI_INVALID_HANDLE.
  8657. Notes
  8658. The new thread will start by executing a call to the function pointed
  8659. to by 'start' with the argument given by 'arg'. When that function
  8660. returns, the new thread will terminate. The function should not
  8661. return a value and should accept one parameter, a 'dvoid *'.
  8662. The call to OCIThreadCreate() must be matched by a call to
  8663. OCIThreadClose() if and only if tHnd is non-NULL.
  8664. If tHnd is NULL, a thread ID placed in *tid will not be valid in the
  8665. calling thread because the timing of the spawned thread's termination
  8666. is unknown.
  8667. 'tid' should be initialized by OCIThreadIdInit().
  8668. 'thnd' should be initialized by OCIThreadHndInit().
  8669. OCIThreadJoin - OCIThread Thread Join
  8670. -------------------------------------
  8671. Description
  8672. This function allows the calling thread to 'join' with another thread.
  8673. It blocks the caller until the specified thread terminates.
  8674. Prototype
  8675. sword OCIThreadJoin(dvoid *hndl, OCIError *err, OCIThreadHandle *tHnd);
  8676. hndl(IN/OUT): The OCI environment or session handle.
  8677. err(IN/OUT): The OCI error handle. If there is an error and OCI_ERROR
  8678. is returned, the error is recorded in err and diagnostic
  8679. information can be obtained by calling OCIErrorGet().
  8680. tHnd(IN): The 'OCIThreadHandle' of the thread to join with.
  8681. Returns
  8682. OCI_SUCCESS, OCI_ERROR or OCI_INVALID_HANDLE.
  8683. Notes
  8684. 'thnd' should be initialized by OCIThreadHndInit().
  8685. The result of multiple threads all trying to join with the same thread is
  8686. undefined.
  8687. OCIThreadClose - OCIThread Thread Close
  8688. ---------------------------------------
  8689. Description
  8690. This function should be called to close a thread handle.
  8691. Prototype
  8692. sword OCIThreadClose(dvoid *hndl, OCIError *err, OCIThreadHandle *tHnd);
  8693. hndl(IN/OUT): The OCI environment or session handle.
  8694. err(IN/OUT): The OCI error handle. If there is an error and OCI_ERROR
  8695. is returned, the error is recorded in err and diagnostic
  8696. information can be obtained by calling OCIErrorGet().
  8697. tHnd(IN/OUT): The OCIThread thread handle to close.
  8698. Returns
  8699. OCI_SUCCESS, OCI_ERROR or OCI_INVALID_HANDLE.
  8700. Notes
  8701. 'thnd' should be initialized by OCIThreadHndInit().
  8702. Both thread handle and the thread ID that was returned by the same call
  8703. to OCIThreadCreate() are invalid after the call to OCIThreadClose().
  8704. OCIThreadHandleGet - OCIThread Thread Get Handle
  8705. ------------------------------------------------
  8706. Description
  8707. Retrieve the 'OCIThreadHandle' of the thread in which it is called.
  8708. Prototype
  8709. sword OCIThreadHandleGet(dvoid *hndl, OCIError *err,
  8710. OCIThreadHandle *tHnd);
  8711. hndl(IN/OUT): The OCI environment or session handle.
  8712. err(IN/OUT): The OCI error handle. If there is an error and OCI_ERROR
  8713. is returned, the error is recorded in err and diagnostic
  8714. information can be obtained by calling OCIErrorGet().
  8715. tHnd(IN/OUT): If not NULL, the location to place the thread
  8716. handle for the thread.
  8717. Returns
  8718. OCI_SUCCESS, OCI_ERROR or OCI_INVALID_HANDLE.
  8719. Notes
  8720. 'thnd' should be initialized by OCIThreadHndInit().
  8721. The thread handle 'tHnd' retrieved by this function must be closed
  8722. with OCIThreadClose() and destroyed by OCIThreadHndDestroy() after it
  8723. is used.
  8724. 1.4 Using OCIThread
  8725. =====================
  8726. This section summarizes some of the more important details relating to the use
  8727. of OCIThread.
  8728. * Process initialization
  8729. OCIThread only requires that the process initialization function
  8730. ('OCIThreadProcessInit()') be called when OCIThread is being used in a
  8731. multi-threaded application. Failing to call 'OCIThreadProcessInit()' in
  8732. a single-threaded application is not an error.
  8733. * OCIThread initialization
  8734. Separate calls to 'OCIThreadInit()' will all return the same OCIThread
  8735. context.
  8736. Also, remember that each call to 'OCIThreadInit()' must eventually be
  8737. matched by a call to 'OCIThreadTerm()'.
  8738. * Active vs. Passive Threading primitives
  8739. OCIThread client code written without using any active primitives can be
  8740. compiled and used without change on both single-threaded and
  8741. multi-threaded platforms.
  8742. OCIThread client code written using active primitives will only work
  8743. correctly on multi-threaded platforms. In order to write a version of the
  8744. same application to run on single-threaded platform, it is necessary to
  8745. branch the your code, whether by branching versions of the source file or
  8746. by branching at runtime with the OCIThreadIsMulti() call.
  8747. ***************************************************************************** }
  8748. {****************************************************************************
  8749. ACTUAL PROTOTYPE DECLARATIONS
  8750. ***************************************************************************** }
  8751. {$IFNDEF LinkDynamically}
  8752. procedure OCIThreadProcessInit;cdecl;external ocilib name 'OCIThreadProcessInit';
  8753. function OCIThreadInit(hndl:Pdvoid; err:POCIError):sword;cdecl;external ocilib name 'OCIThreadInit';
  8754. function OCIThreadTerm(hndl:Pdvoid; err:POCIError):sword;cdecl;external ocilib name 'OCIThreadTerm';
  8755. function OCIThreadIsMulti:boolean;cdecl;external ocilib name 'OCIThreadIsMulti';
  8756. function OCIThreadMutexInit(hndl:Pdvoid; err:POCIError; var mutex:POCIThreadMutex):sword;cdecl;external ocilib name 'OCIThreadMutexInit';
  8757. function OCIThreadMutexDestroy(hndl:Pdvoid; err:POCIError; var mutex:POCIThreadMutex):sword;cdecl;external ocilib name 'OCIThreadMutexDestroy';
  8758. function OCIThreadMutexAcquire(hndl:Pdvoid; err:POCIError; mutex:POCIThreadMutex):sword;cdecl;external ocilib name 'OCIThreadMutexAcquire';
  8759. function OCIThreadMutexRelease(hndl:Pdvoid; err:POCIError; mutex:POCIThreadMutex):sword;cdecl;external ocilib name 'OCIThreadMutexRelease';
  8760. function OCIThreadKeyInit(hndl:Pdvoid; err:POCIError; var key:POCIThreadKey; destFn:OCIThreadKeyDestFunc):sword;cdecl;external ocilib name 'OCIThreadKeyInit';
  8761. function OCIThreadKeyDestroy(hndl:Pdvoid; err:POCIError; var key:POCIThreadKey):sword;cdecl;external ocilib name 'OCIThreadKeyDestroy';
  8762. function OCIThreadKeyGet(hndl:Pdvoid; err:POCIError; key:POCIThreadKey; pValue:PPdvoid):sword;cdecl;external ocilib name 'OCIThreadKeyGet';
  8763. function OCIThreadKeySet(hndl:Pdvoid; err:POCIError; key:POCIThreadKey; value:Pdvoid):sword;cdecl;external ocilib name 'OCIThreadKeySet';
  8764. function OCIThreadIdInit(hndl:Pdvoid; err:POCIError; var tid:POCIThreadId):sword;cdecl;external ocilib name 'OCIThreadIdInit';
  8765. function OCIThreadIdDestroy(hndl:Pdvoid; err:POCIError; var tid:POCIThreadId):sword;cdecl;external ocilib name 'OCIThreadIdDestroy';
  8766. function OCIThreadIdSet(hndl:Pdvoid; err:POCIError; tidDest:POCIThreadId; tidSrc:POCIThreadId):sword;cdecl;external ocilib name 'OCIThreadIdSet';
  8767. function OCIThreadIdSetNull(hndl:Pdvoid; err:POCIError; tid:POCIThreadId):sword;cdecl;external ocilib name 'OCIThreadIdSetNull';
  8768. function OCIThreadIdGet(hndl:Pdvoid; err:POCIError; tid:POCIThreadId):sword;cdecl;external ocilib name 'OCIThreadIdGet';
  8769. function OCIThreadIdSame(hndl:Pdvoid; err:POCIError; tid1:POCIThreadId; tid2:POCIThreadId; result:Pboolean):sword;cdecl;external ocilib name 'OCIThreadIdSame';
  8770. function OCIThreadIdNull(hndl:Pdvoid; err:POCIError; tid:POCIThreadId; result:Pboolean):sword;cdecl;external ocilib name 'OCIThreadIdNull';
  8771. function OCIThreadHndInit(hndl:Pdvoid; err:POCIError; var thnd:POCIThreadHandle):sword;cdecl;external ocilib name 'OCIThreadHndInit';
  8772. function OCIThreadHndDestroy(hndl:Pdvoid; err:POCIError; var thnd:POCIThreadHandle):sword;cdecl;external ocilib name 'OCIThreadHndDestroy';
  8773. {$ELSE}
  8774. var OCIThreadProcessInit : procedure;cdecl;
  8775. OCIThreadInit : function (hndl:Pdvoid; err:POCIError):sword;cdecl;
  8776. OCIThreadTerm : function (hndl:Pdvoid; err:POCIError):sword;cdecl;
  8777. OCIThreadIsMulti: function : boolean;cdecl;
  8778. OCIThreadMutexInit : function (hndl:Pdvoid; err:POCIError; var mutex:POCIThreadMutex):sword;cdecl;
  8779. OCIThreadMutexDestroy : function (hndl:Pdvoid; err:POCIError; var mutex:POCIThreadMutex):sword;cdecl;
  8780. OCIThreadMutexAcquire : function (hndl:Pdvoid; err:POCIError; mutex:POCIThreadMutex):sword;cdecl;
  8781. OCIThreadMutexRelease : function (hndl:Pdvoid; err:POCIError; mutex:POCIThreadMutex):sword;cdecl;
  8782. OCIThreadKeyInit : function (hndl:Pdvoid; err:POCIError; var key:POCIThreadKey; destFn:OCIThreadKeyDestFunc):sword;cdecl;
  8783. OCIThreadKeyDestroy : function (hndl:Pdvoid; err:POCIError; var key:POCIThreadKey):sword;cdecl;
  8784. OCIThreadKeyGet : function (hndl:Pdvoid; err:POCIError; key:POCIThreadKey; pValue:PPdvoid):sword;cdecl;
  8785. OCIThreadKeySet : function (hndl:Pdvoid; err:POCIError; key:POCIThreadKey; value:Pdvoid):sword;cdecl;
  8786. OCIThreadIdInit : function (hndl:Pdvoid; err:POCIError; var tid:POCIThreadId):sword;cdecl;
  8787. OCIThreadIdDestroy : function (hndl:Pdvoid; err:POCIError; var tid:POCIThreadId):sword;cdecl;
  8788. OCIThreadIdSet : function (hndl:Pdvoid; err:POCIError; tidDest:POCIThreadId; tidSrc:POCIThreadId):sword;cdecl;
  8789. OCIThreadIdSetNull : function (hndl:Pdvoid; err:POCIError; tid:POCIThreadId):sword;cdecl;
  8790. OCIThreadIdGet : function (hndl:Pdvoid; err:POCIError; tid:POCIThreadId):sword;cdecl;
  8791. OCIThreadIdSame : function (hndl:Pdvoid; err:POCIError; tid1:POCIThreadId; tid2:POCIThreadId; result:Pboolean):sword;cdecl;
  8792. OCIThreadIdNull : function (hndl:Pdvoid; err:POCIError; tid:POCIThreadId; result:Pboolean):sword;cdecl;
  8793. OCIThreadHndInit : function (hndl:Pdvoid; err:POCIError; var thnd:POCIThreadHandle):sword;cdecl;
  8794. OCIThreadHndDestroy : function (hndl:Pdvoid; err:POCIError; var thnd:POCIThreadHandle):sword;cdecl;
  8795. {$ENDIF}
  8796. type
  8797. tstart = procedure (_para1:Pdvoid);
  8798. {$IFNDEF LinkDynamically}
  8799. function OCIThreadCreate(hndl:Pdvoid; err:POCIError; start :tstart; arg:Pdvoid; tid:POCIThreadId;
  8800. tHnd:POCIThreadHandle):sword;cdecl;external ocilib name 'OCIThreadCreate';
  8801. function OCIThreadJoin(hndl:Pdvoid; err:POCIError; tHnd:POCIThreadHandle):sword;cdecl;external ocilib name 'OCIThreadJoin';
  8802. function OCIThreadClose(hndl:Pdvoid; err:POCIError; tHnd:POCIThreadHandle):sword;cdecl;external ocilib name 'OCIThreadClose';
  8803. function OCIThreadHandleGet(hndl:Pdvoid; err:POCIError; tHnd:POCIThreadHandle):sword;cdecl;external ocilib name 'OCIThreadHandleGet';
  8804. {$ELSE}
  8805. var OCIThreadCreate : function (hndl:Pdvoid; err:POCIError; start :tstart; arg:Pdvoid; tid:POCIThreadId;
  8806. tHnd:POCIThreadHandle):sword;cdecl;
  8807. OCIThreadJoin : function (hndl:Pdvoid; err:POCIError; tHnd:POCIThreadHandle):sword;cdecl;
  8808. OCIThreadClose : function (hndl:Pdvoid; err:POCIError; tHnd:POCIThreadHandle):sword;cdecl;
  8809. OCIThreadHandleGet : function (hndl:Pdvoid; err:POCIError; tHnd:POCIThreadHandle):sword;cdecl;
  8810. {$ENDIF}
  8811. {----------------- End OCI Thread interface Extensions --------------------- }
  8812. {------------------ Begin OCI Row Callback Interfaces ---------------------- }
  8813. type
  8814. OCIBindRowCallback = function (ctx:Pdvoid):sword;cdecl;
  8815. OCIFetchRowCallback = function (ctx:Pdvoid):sword;cdecl;
  8816. {------------------ Begin OCI Row Callback Interfaces ---------------------- }
  8817. {--------------- Begin OCI Client Notification Interfaces ------------------ }
  8818. OCISubscriptionNotify = function (ctx:Pdvoid; subscrhp:POCISubscription; pay:Pdvoid; payl:ub4; desc:Pdvoid;
  8819. mode:ub4):ub4;cdecl;
  8820. {$IFNDEF LinkDynamically}
  8821. function OCISubscriptionRegister(svchp:POCISvcCtx; var subscrhpp:POCISubscription; count:ub2; errhp:POCIError; mode:ub4):sword;cdecl;external ocilib name 'OCISubscriptionRegister';
  8822. function OCISubscriptionPost(svchp:POCISvcCtx; var subscrhpp:POCISubscription; count:ub2; errhp:POCIError; mode:ub4):sword;cdecl;external ocilib name 'OCISubscriptionPost';
  8823. function OCISubscriptionUnRegister(svchp:POCISvcCtx; subscrhp:POCISubscription; errhp:POCIError; mode:ub4):sword;cdecl;external ocilib name 'OCISubscriptionUnRegister';
  8824. function OCISubscriptionDisable(subscrhp:POCISubscription; errhp:POCIError; mode:ub4):sword;cdecl;external ocilib name 'OCISubscriptionDisable';
  8825. function OCISubscriptionEnable(subscrhp:POCISubscription; errhp:POCIError; mode:ub4):sword;cdecl;external ocilib name 'OCISubscriptionEnable';
  8826. {------------------- End OCI Publish/Subscribe Interfaces ------------------ }
  8827. {----------------- Extensions to Datetime interfaces ----------------------- }
  8828. {--------------------- Actual Prototypes ----------------------------------- }
  8829. function OCIDateTimeGetTime(hndl:Pdvoid; err:POCIError; datetime:POCIDateTime; hr:Pub1; mm:Pub1;
  8830. ss:Pub1; fsec:Pub4):sword;cdecl;external ocilib name 'OCIDateTimeGetTime';
  8831. function OCIDateTimeGetDate(hndl:Pdvoid; err:POCIError; date:POCIDateTime; yr:Psb2; mnth:Pub1;
  8832. dy:Pub1):sword;cdecl;external ocilib name 'OCIDateTimeGetDate';
  8833. function OCIDateTimeGetTimeZoneOffset(hndl:Pdvoid; err:POCIError; datetime:POCIDateTime; hr:Psb1; mm:Psb1):sword;cdecl;external ocilib name 'OCIDateTimeGetTimeZoneOffset';
  8834. function OCIDateTimeConstruct(hndl:Pdvoid; err:POCIError; datetime:POCIDateTime; yr:sb2; mnth:ub1;
  8835. dy:ub1; hr:ub1; mm:ub1; ss:ub1; fsec:ub4;
  8836. timezone:POraText; timezone_length:size_t):sword;cdecl;external ocilib name 'OCIDateTimeConstruct';
  8837. function OCIDateTimeSysTimeStamp(hndl:Pdvoid; err:POCIError; sys_date:POCIDateTime):sword;cdecl;external ocilib name 'OCIDateTimeSysTimeStamp';
  8838. function OCIDateTimeAssign(hndl:Pdvoid; err:POCIError; from:POCIDateTime; cto:POCIDateTime):sword;cdecl;external ocilib name 'OCIDateTimeAssign';
  8839. function OCIDateTimeToText(hndl:Pdvoid; err:POCIError; date:POCIDateTime; fmt:POraText; fmt_length:ub1;
  8840. fsprec:ub1; lang_name:POraText; lang_length:size_t; buf_size:Pub4; buf:POraText):sword;cdecl;external ocilib name 'OCIDateTimeToText';
  8841. function OCIDateTimeFromText(hndl:Pdvoid; err:POCIError; date_str:POraText; dstr_length:size_t; fmt:POraText;
  8842. fmt_length:ub1; lang_name:POraText; lang_length:size_t; date:POCIDateTime):sword;cdecl;external ocilib name 'OCIDateTimeFromText';
  8843. function OCIDateTimeCompare(hndl:Pdvoid; err:POCIError; date1:POCIDateTime; date2:POCIDateTime; result:Psword):sword;cdecl;external ocilib name 'OCIDateTimeCompare';
  8844. function OCIDateTimeCheck(hndl:Pdvoid; err:POCIError; date:POCIDateTime; valid:Pub4):sword;cdecl;external ocilib name 'OCIDateTimeCheck';
  8845. function OCIDateTimeConvert(hndl:Pdvoid; err:POCIError; indate:POCIDateTime; outdate:POCIDateTime):sword;cdecl;external ocilib name 'OCIDateTimeConvert';
  8846. function OCIDateTimeSubtract(hndl:Pdvoid; err:POCIError; indate1:POCIDateTime; indate2:POCIDateTime; inter:POCIInterval):sword;cdecl;external ocilib name 'OCIDateTimeSubtract';
  8847. function OCIDateTimeIntervalAdd(hndl:Pdvoid; err:POCIError; datetime:POCIDateTime; inter:POCIInterval; outdatetime:POCIDateTime):sword;cdecl;external ocilib name 'OCIDateTimeIntervalAdd';
  8848. function OCIDateTimeIntervalSub(hndl:Pdvoid; err:POCIError; datetime:POCIDateTime; inter:POCIInterval; outdatetime:POCIDateTime):sword;cdecl;external ocilib name 'OCIDateTimeIntervalSub';
  8849. function OCIIntervalSubtract(hndl:Pdvoid; err:POCIError; minuend:POCIInterval; subtrahend:POCIInterval; result:POCIInterval):sword;cdecl;external ocilib name 'OCIIntervalSubtract';
  8850. function OCIIntervalAdd(hndl:Pdvoid; err:POCIError; addend1:POCIInterval; addend2:POCIInterval; result:POCIInterval):sword;cdecl;external ocilib name 'OCIIntervalAdd';
  8851. function OCIIntervalMultiply(hndl:Pdvoid; err:POCIError; inter:POCIInterval; nfactor:POCINumber; result:POCIInterval):sword;cdecl;external ocilib name 'OCIIntervalMultiply';
  8852. function OCIIntervalDivide(hndl:Pdvoid; err:POCIError; dividend:POCIInterval; divisor:POCINumber; result:POCIInterval):sword;cdecl;external ocilib name 'OCIIntervalDivide';
  8853. function OCIIntervalCompare(hndl:Pdvoid; err:POCIError; inter1:POCIInterval; inter2:POCIInterval; result:Psword):sword;cdecl;external ocilib name 'OCIIntervalCompare';
  8854. function OCIIntervalFromNumber(hndl:Pdvoid; err:POCIError; inter:POCIInterval; number:POCINumber):sword;cdecl;external ocilib name 'OCIIntervalFromNumber';
  8855. function OCIIntervalFromText(hndl:Pdvoid; err:POCIError; inpstr:POraText; str_len:size_t; result:POCIInterval):sword;cdecl;external ocilib name 'OCIIntervalFromText';
  8856. function OCIIntervalToText(hndl:Pdvoid; err:POCIError; inter:POCIInterval; lfprec:ub1; fsprec:ub1;
  8857. buffer:POraText; buflen:size_t; resultlen:Psize_t):sword;cdecl;external ocilib name 'OCIIntervalToText';
  8858. function OCIIntervalToNumber(hndl:Pdvoid; err:POCIError; inter:POCIInterval; number:POCINumber):sword;cdecl;external ocilib name 'OCIIntervalToNumber';
  8859. function OCIIntervalCheck(hndl:Pdvoid; err:POCIError; interval:POCIInterval; valid:Pub4):sword;cdecl;external ocilib name 'OCIIntervalCheck';
  8860. function OCIIntervalAssign(hndl:Pdvoid; err:POCIError; ininter:POCIInterval; outinter:POCIInterval):sword;cdecl;external ocilib name 'OCIIntervalAssign';
  8861. function OCIIntervalSetYearMonth(hndl:Pdvoid; err:POCIError; yr:sb4; mnth:sb4; result:POCIInterval):sword;cdecl;external ocilib name 'OCIIntervalSetYearMonth';
  8862. function OCIIntervalGetYearMonth(hndl:Pdvoid; err:POCIError; yr:Psb4; mnth:Psb4; result:POCIInterval):sword;cdecl;external ocilib name 'OCIIntervalGetYearMonth';
  8863. function OCIIntervalSetDaySecond(hndl:Pdvoid; err:POCIError; dy:sb4; hr:sb4; mm:sb4;
  8864. ss:sb4; fsec:sb4; result:POCIInterval):sword;cdecl;external ocilib name 'OCIIntervalSetDaySecond';
  8865. function OCIIntervalGetDaySecond(hndl:Pdvoid; err:POCIError; dy:Psb4; hr:Psb4; mm:Psb4;
  8866. ss:Psb4; fsec:Psb4; result:POCIInterval):sword;cdecl;external ocilib name 'OCIIntervalGetDaySecond';
  8867. function OCIDateTimeToArray(hndl:Pdvoid; err:POCIError; datetime:POCIDateTime; reftz:POCIInterval; outarray:Pub1;
  8868. len:Pub4; fsprec:ub1):sword;cdecl;external ocilib name 'OCIDateTimeToArray';
  8869. function OCIDateTimeFromArray(hndl:Pdvoid; err:POCIError; inarray:Pub1; len:ub4; _type:ub1;
  8870. datetime:POCIDateTime; reftz:POCIInterval; fsprec:ub1):sword;cdecl;external ocilib name 'OCIDateTimeFromArray';
  8871. function OCIDateTimeGetTimeZoneName(hndl:Pdvoid; err:POCIError; datetime:POCIDateTime; buf:Pub1; buflen:Pub4):sword;cdecl;external ocilib name 'OCIDateTimeGetTimeZoneName';
  8872. function OCIIntervalFromTZ(hndl:Pdvoid; err:POCIError; inpstring:Poratext; str_len:size_t; result:POCIInterval):sword;cdecl;external ocilib name 'OCIIntervalFromTZ';
  8873. {----------------- End Datetime interface Extensions ----------------------- }
  8874. {----------------- Connection Pooling prototypes --------------------------- }
  8875. function OCIConnectionPoolCreate(envhp:POCIEnv; errhp:POCIError; poolhp:POCICPool; var poolName:POraText; poolNameLen:Psb4;
  8876. dblink:POraText; dblinkLen:sb4; connMin:ub4; connMax:ub4; connIncr:ub4;
  8877. poolUserName:POraText; poolUserLen:sb4; poolPassword:POraText; poolPassLen:sb4; mode:ub4):sword;cdecl;external ocilib name 'OCIConnectionPoolCreate';
  8878. function OCIConnectionPoolDestroy(poolhp:POCICPool; errhp:POCIError; mode:ub4):sword;cdecl;external ocilib name 'OCIConnectionPoolDestroy';
  8879. {----------------- End Connection Pooling prototypes ----------------------- }
  8880. {-------------------- Session Pooling prototypes --------------------------- }
  8881. function OCISessionPoolCreate(envhp:POCIEnv; errhp:POCIError; spoolhp:POCISPool; var poolName:POraText; poolNameLen:Pub4;
  8882. connStr:POraText; connStrLen:ub4; sessMin:ub4; sessMax:ub4; sessIncr:ub4;
  8883. userid:POraText; useridLen:ub4; password:POraText; passwordLen:ub4; mode:ub4):sword;cdecl;external ocilib name 'OCISessionPoolCreate';
  8884. function OCISessionPoolDestroy(spoolhp:POCISPool; errhp:POCIError; mode:ub4):sword;cdecl;external ocilib name 'OCISessionPoolDestroy';
  8885. function OCISessionGet(envhp:POCIEnv; errhp:POCIError; var svchp:POCISvcCtx; authhp:POCIAuthInfo; poolName:POraText;
  8886. poolName_len:ub4; tagInfo:POraText; tagInfo_len:ub4; var retTagInfo:POraText; retTagInfo_len:Pub4;
  8887. found:Pboolean; mode:ub4):sword;cdecl;external ocilib name 'OCISessionGet';
  8888. function OCISessionRelease(svchp:POCISvcCtx; errhp:POCIError; tag:POraText; tag_len:ub4; mode:ub4):sword;cdecl;external ocilib name 'OCISessionRelease';
  8889. {-------------------- End Session Pooling prototypes ----------------------- }
  8890. { --------------------- OCI Application Context -------------------------- }
  8891. function OCIAppCtxSet(sesshndl:pointer; nsptr:Pdvoid; nsptrlen:ub4; attrptr:Pdvoid; attrptrlen:ub4;
  8892. valueptr:Pdvoid; valueptrlen:ub4; errhp:POCIError; mode:ub4):sword;cdecl;external ocilib name 'OCIAppCtxSet';
  8893. function OCIAppCtxClearAll(sesshndl:pointer; nsptr:Pdvoid; nsptrlen:ub4; errhp:POCIError; mode:ub4):sword;cdecl;external ocilib name 'OCIAppCtxClearAll';
  8894. {-------------------------------- OCIPing ---------------------------------- }
  8895. function OCIPing(svchp:POCISvcCtx; errhp:POCIError; mode:ub4):sword;cdecl;external ocilib name 'OCIPing';
  8896. {----------------- Kerberos Authentication prototypes ---------------------- }
  8897. function OCIKerbAttrSet(trgthndlp:POCISession; cred_use:ub4; ftgt_ticket:Pub1; ticket_len:ub4; session_key:Pub1;
  8898. skey_len:ub4; ftgt_keytype:ub2; ftgt_ticket_flags:ub4; ftgt_auth_time:sb4; ftgt_start_time:sb4;
  8899. ftgt_end_time:sb4; ftgt_renew_time:sb4; ftgt_client_principal:Ptext; ftgt_client_principal_len:ub4; ftgt_client_realm:Ptext;
  8900. ftgt_client_realm_len:ub4; errhp:POCIError):sword;cdecl;external ocilib name 'OCIKerbAttrSet';
  8901. {------------------- End Kerberos Authentication prototypes ---------------- }
  8902. {------------------- Database Startup/Shutdown prototypes ------------------ }
  8903. function OCIDBStartup(svchp:POCISvcCtx; errhp:POCIError; admhp:POCIAdmin; mode:ub4; flags:ub4):sword;cdecl;external ocilib name 'OCIDBStartup';
  8904. function OCIDBShutdown(svchp:POCISvcCtx; errhp:POCIError; admhp:POCIAdmin; mode:ub4):sword;cdecl;external ocilib name 'OCIDBShutdown';
  8905. {------------------ End Database Startup/Shutdown prototypes --------------- }
  8906. {----------------------- OCIClientVersion ------------------------------ }
  8907. procedure OCIClientVersion(major_version:Psword; minor_version:Psword; update_num:Psword; patch_num:Psword; port_update_num:Psword);cdecl;external ocilib name 'OCIClientVersion';
  8908. {----------------------- End OCIClientVersion -------------------------- }
  8909. {----------------------- HA Event prototypes ------------------------------ }
  8910. function OCIInitEventHandle(errhp:POCIError; event:POCIEvent; str:Ptext; size:ub4):sword;cdecl;external ocilib name 'OCIInitEventHandle';
  8911. {----------------------- End HA Event prototypes -------------------------- }
  8912. {$ELSE}
  8913. var OCISubscriptionRegister : function (svchp:POCISvcCtx; var subscrhpp:POCISubscription; count:ub2; errhp:POCIError; mode:ub4):sword;cdecl;
  8914. OCISubscriptionPost : function (svchp:POCISvcCtx; var subscrhpp:POCISubscription; count:ub2; errhp:POCIError; mode:ub4):sword;cdecl;
  8915. OCISubscriptionUnRegister : function (svchp:POCISvcCtx; subscrhp:POCISubscription; errhp:POCIError; mode:ub4):sword;cdecl;
  8916. OCISubscriptionDisable : function (subscrhp:POCISubscription; errhp:POCIError; mode:ub4):sword;cdecl;
  8917. OCISubscriptionEnable : function (subscrhp:POCISubscription; errhp:POCIError; mode:ub4):sword;cdecl;
  8918. {------------------- End OCI Publish/Subscribe Interfaces ------------------ }
  8919. {----------------- Extensions to Datetime interfaces ----------------------- }
  8920. {--------------------- Actual Prototypes ----------------------------------- }
  8921. OCIDateTimeGetTime : function (hndl:Pdvoid; err:POCIError; datetime:POCIDateTime; hr:Pub1; mm:Pub1;
  8922. ss:Pub1; fsec:Pub4):sword;cdecl;
  8923. OCIDateTimeGetDate : function (hndl:Pdvoid; err:POCIError; date:POCIDateTime; yr:Psb2; mnth:Pub1;
  8924. dy:Pub1):sword;cdecl;
  8925. OCIDateTimeGetTimeZoneOffset : function (hndl:Pdvoid; err:POCIError; datetime:POCIDateTime; hr:Psb1; mm:Psb1):sword;cdecl;
  8926. OCIDateTimeConstruct : function (hndl:Pdvoid; err:POCIError; datetime:POCIDateTime; yr:sb2; mnth:ub1;
  8927. dy:ub1; hr:ub1; mm:ub1; ss:ub1; fsec:ub4;
  8928. timezone:POraText; timezone_length:size_t):sword;cdecl;
  8929. OCIDateTimeSysTimeStamp : function (hndl:Pdvoid; err:POCIError; sys_date:POCIDateTime):sword;cdecl;
  8930. OCIDateTimeAssign : function (hndl:Pdvoid; err:POCIError; from:POCIDateTime; cto:POCIDateTime):sword;cdecl;
  8931. OCIDateTimeToText : function (hndl:Pdvoid; err:POCIError; date:POCIDateTime; fmt:POraText; fmt_length:ub1;
  8932. fsprec:ub1; lang_name:POraText; lang_length:size_t; buf_size:Pub4; buf:POraText):sword;cdecl;
  8933. OCIDateTimeFromText : function (hndl:Pdvoid; err:POCIError; date_str:POraText; dstr_length:size_t; fmt:POraText;
  8934. fmt_length:ub1; lang_name:POraText; lang_length:size_t; date:POCIDateTime):sword;cdecl;
  8935. OCIDateTimeCompare : function (hndl:Pdvoid; err:POCIError; date1:POCIDateTime; date2:POCIDateTime; result:Psword):sword;cdecl;
  8936. OCIDateTimeCheck : function (hndl:Pdvoid; err:POCIError; date:POCIDateTime; valid:Pub4):sword;cdecl;
  8937. OCIDateTimeConvert : function (hndl:Pdvoid; err:POCIError; indate:POCIDateTime; outdate:POCIDateTime):sword;cdecl;
  8938. OCIDateTimeSubtract : function (hndl:Pdvoid; err:POCIError; indate1:POCIDateTime; indate2:POCIDateTime; inter:POCIInterval):sword;cdecl;
  8939. OCIDateTimeIntervalAdd : function (hndl:Pdvoid; err:POCIError; datetime:POCIDateTime; inter:POCIInterval; outdatetime:POCIDateTime):sword;cdecl;
  8940. OCIDateTimeIntervalSub : function (hndl:Pdvoid; err:POCIError; datetime:POCIDateTime; inter:POCIInterval; outdatetime:POCIDateTime):sword;cdecl;
  8941. OCIIntervalSubtract : function (hndl:Pdvoid; err:POCIError; minuend:POCIInterval; subtrahend:POCIInterval; result:POCIInterval):sword;cdecl;
  8942. OCIIntervalAdd : function (hndl:Pdvoid; err:POCIError; addend1:POCIInterval; addend2:POCIInterval; result:POCIInterval):sword;cdecl;
  8943. OCIIntervalMultiply : function (hndl:Pdvoid; err:POCIError; inter:POCIInterval; nfactor:POCINumber; result:POCIInterval):sword;cdecl;
  8944. OCIIntervalDivide : function (hndl:Pdvoid; err:POCIError; dividend:POCIInterval; divisor:POCINumber; result:POCIInterval):sword;cdecl;
  8945. OCIIntervalCompare : function (hndl:Pdvoid; err:POCIError; inter1:POCIInterval; inter2:POCIInterval; result:Psword):sword;cdecl;
  8946. OCIIntervalFromNumber : function (hndl:Pdvoid; err:POCIError; inter:POCIInterval; number:POCINumber):sword;cdecl;
  8947. OCIIntervalFromText : function (hndl:Pdvoid; err:POCIError; inpstr:POraText; str_len:size_t; result:POCIInterval):sword;cdecl;
  8948. OCIIntervalToText : function (hndl:Pdvoid; err:POCIError; inter:POCIInterval; lfprec:ub1; fsprec:ub1;
  8949. buffer:POraText; buflen:size_t; resultlen:Psize_t):sword;cdecl;
  8950. OCIIntervalToNumber : function (hndl:Pdvoid; err:POCIError; inter:POCIInterval; number:POCINumber):sword;cdecl;
  8951. OCIIntervalCheck : function (hndl:Pdvoid; err:POCIError; interval:POCIInterval; valid:Pub4):sword;cdecl;
  8952. OCIIntervalAssign : function (hndl:Pdvoid; err:POCIError; ininter:POCIInterval; outinter:POCIInterval):sword;cdecl;
  8953. OCIIntervalSetYearMonth : function (hndl:Pdvoid; err:POCIError; yr:sb4; mnth:sb4; result:POCIInterval):sword;cdecl;
  8954. OCIIntervalGetYearMonth : function (hndl:Pdvoid; err:POCIError; yr:Psb4; mnth:Psb4; result:POCIInterval):sword;cdecl;
  8955. OCIIntervalSetDaySecond : function (hndl:Pdvoid; err:POCIError; dy:sb4; hr:sb4; mm:sb4;
  8956. ss:sb4; fsec:sb4; result:POCIInterval):sword;cdecl;
  8957. OCIIntervalGetDaySecond : function (hndl:Pdvoid; err:POCIError; dy:Psb4; hr:Psb4; mm:Psb4;
  8958. ss:Psb4; fsec:Psb4; result:POCIInterval):sword;cdecl;
  8959. OCIDateTimeToArray : function (hndl:Pdvoid; err:POCIError; datetime:POCIDateTime; reftz:POCIInterval; outarray:Pub1;
  8960. len:Pub4; fsprec:ub1):sword;cdecl;
  8961. OCIDateTimeFromArray : function (hndl:Pdvoid; err:POCIError; inarray:Pub1; len:ub4; _type:ub1;
  8962. datetime:POCIDateTime; reftz:POCIInterval; fsprec:ub1):sword;cdecl;
  8963. OCIDateTimeGetTimeZoneName : function (hndl:Pdvoid; err:POCIError; datetime:POCIDateTime; buf:Pub1; buflen:Pub4):sword;cdecl;
  8964. OCIIntervalFromTZ : function (hndl:Pdvoid; err:POCIError; inpstring:Poratext; str_len:size_t; result:POCIInterval):sword;cdecl;
  8965. {----------------- End Datetime interface Extensions ----------------------- }
  8966. {----------------- Connection Pooling prototypes --------------------------- }
  8967. OCIConnectionPoolCreate : function (envhp:POCIEnv; errhp:POCIError; poolhp:POCICPool; var poolName:POraText; poolNameLen:Psb4;
  8968. dblink:POraText; dblinkLen:sb4; connMin:ub4; connMax:ub4; connIncr:ub4;
  8969. poolUserName:POraText; poolUserLen:sb4; poolPassword:POraText; poolPassLen:sb4; mode:ub4):sword;cdecl;
  8970. OCIConnectionPoolDestroy : function (poolhp:POCICPool; errhp:POCIError; mode:ub4):sword;cdecl;
  8971. {----------------- End Connection Pooling prototypes ----------------------- }
  8972. {-------------------- Session Pooling prototypes --------------------------- }
  8973. OCISessionPoolCreate : function (envhp:POCIEnv; errhp:POCIError; spoolhp:POCISPool; var poolName:POraText; poolNameLen:Pub4;
  8974. connStr:POraText; connStrLen:ub4; sessMin:ub4; sessMax:ub4; sessIncr:ub4;
  8975. userid:POraText; useridLen:ub4; password:POraText; passwordLen:ub4; mode:ub4):sword;cdecl;
  8976. OCISessionPoolDestroy : function (spoolhp:POCISPool; errhp:POCIError; mode:ub4):sword;cdecl;
  8977. OCISessionGet : function (envhp:POCIEnv; errhp:POCIError; var svchp:POCISvcCtx; authhp:POCIAuthInfo; poolName:POraText;
  8978. poolName_len:ub4; tagInfo:POraText; tagInfo_len:ub4; var retTagInfo:POraText; retTagInfo_len:Pub4;
  8979. found:Pboolean; mode:ub4):sword;cdecl;
  8980. OCISessionRelease : function (svchp:POCISvcCtx; errhp:POCIError; tag:POraText; tag_len:ub4; mode:ub4):sword;cdecl;
  8981. {-------------------- End Session Pooling prototypes ----------------------- }
  8982. { --------------------- OCI Application Context -------------------------- }
  8983. OCIAppCtxSet : function (sesshndl:pointer; nsptr:Pdvoid; nsptrlen:ub4; attrptr:Pdvoid; attrptrlen:ub4;
  8984. valueptr:Pdvoid; valueptrlen:ub4; errhp:POCIError; mode:ub4):sword;cdecl;
  8985. OCIAppCtxClearAll : function (sesshndl:pointer; nsptr:Pdvoid; nsptrlen:ub4; errhp:POCIError; mode:ub4):sword;cdecl;
  8986. {-------------------------------- OCIPing ---------------------------------- }
  8987. OCIPing : function (svchp:POCISvcCtx; errhp:POCIError; mode:ub4):sword;cdecl;
  8988. {----------------- Kerberos Authentication prototypes ---------------------- }
  8989. OCIKerbAttrSet : function (trgthndlp:POCISession; cred_use:ub4; ftgt_ticket:Pub1; ticket_len:ub4; session_key:Pub1;
  8990. skey_len:ub4; ftgt_keytype:ub2; ftgt_ticket_flags:ub4; ftgt_auth_time:sb4; ftgt_start_time:sb4;
  8991. ftgt_end_time:sb4; ftgt_renew_time:sb4; ftgt_client_principal:Ptext; ftgt_client_principal_len:ub4; ftgt_client_realm:Ptext;
  8992. ftgt_client_realm_len:ub4; errhp:POCIError):sword;cdecl;
  8993. {------------------- End Kerberos Authentication prototypes ---------------- }
  8994. {------------------- Database Startup/Shutdown prototypes ------------------ }
  8995. OCIDBStartup : function (svchp:POCISvcCtx; errhp:POCIError; admhp:POCIAdmin; mode:ub4; flags:ub4):sword;cdecl;
  8996. OCIDBShutdown : function (svchp:POCISvcCtx; errhp:POCIError; admhp:POCIAdmin; mode:ub4):sword;cdecl;
  8997. {------------------ End Database Startup/Shutdown prototypes --------------- }
  8998. {----------------------- OCIClientVersion ------------------------------ }
  8999. OCIClientVersion : procedure (major_version:Psword; minor_version:Psword; update_num:Psword; patch_num:Psword; port_update_num:Psword);cdecl;
  9000. {----------------------- End OCIClientVersion -------------------------- }
  9001. {----------------------- HA Event prototypes ------------------------------ }
  9002. OCIInitEventHandle : function (errhp:POCIError; event:POCIEvent; str:Ptext; size:ub4):sword;cdecl;
  9003. {----------------------- End HA Event prototypes -------------------------- }
  9004. {$ENDIF}
  9005. {---------------------------------------------------------------------------
  9006. PRIVATE FUNCTIONS
  9007. --------------------------------------------------------------------------- }
  9008. { the following functions are depracated and should not be used }
  9009. {$ifdef NEVER}
  9010. function OCIStmtBindByPos(stmtp:POCIStmt; bindp:POCIBind; errhp:POCIError; position:ub4; valuep:Pdvoid;
  9011. value_sz:sb4; dty:ub2; indp:Pdvoid; alenp:Pub2; rcodep:Pub2;
  9012. maxarr_len:ub4; curelep:Pub4; mode:ub4):sword;cdecl;external ocilib name 'OCIStmtBindByPos';
  9013. (* Const before type ignored *)
  9014. function OCIStmtBindByName(stmtp:POCIStmt; bindp:POCIBind; errhp:POCIError; placeholder:POraText; placeh_len:sb4;
  9015. valuep:Pdvoid; value_sz:sb4; dty:ub2; indp:Pdvoid; alenp:Pub2;
  9016. rcodep:Pub2; maxarr_len:ub4; curelep:Pub4; mode:ub4):sword;cdecl;external ocilib name 'OCIStmtBindByName';
  9017. function ocidefn(stmtp:POCIStmt; defnp:POCIDefine; errhp:POCIError; position:ub4; valuep:Pdvoid;
  9018. value_sz:sb4; dty:ub2; indp:Pdvoid; rlenp:Pub2; rcodep:Pub2;
  9019. mode:ub4):sword;cdecl;external ocilib name 'ocidefn';
  9020. {$endif}
  9021. { NEVER }
  9022. {$endif}
  9023. { OCIAP_ORACLE }