Documentation Plugin API/SDK

Oct 18, 2008
339
2
Hello –

I am having an issue with my pluging and I would just like to clarify when a plugin function or variable returns text ....

- The returned value is copied into the same buffer that was pass to the function that contained the arguments to the function

- The buffer is 8192 “bytes” large, thus it can hold 4096 unicode (TCHAR) characters, the
return value must terminate with a null, or zero value, so the longest string would be 4095 characters, plus one (1) unicode zero character

Thanks
 

Charles Dye

Super Moderator
Staff member
May 20, 2008
4,466
88
Albuquerque, NM
prospero.unm.edu
- The returned value is copied into the same buffer that was pass to the function that contained the arguments to the function

Yes.

- The buffer is 8192 “bytes” large, thus it can hold 4096 unicode (TCHAR) characters, the
return value must terminate with a null, or zero value, so the longest string would be 4095 characters, plus one (1) unicode zero character

I haven't tested, but I think it's more than that: 8K wide characters, or 16 kilobytes. Might even be more -- Rex does sometimes increase buffer sizes in a new version.
 
Oct 18, 2008
339
2
Yes.



I haven't tested, but I think it's more than that: 8K wide characters, or 16 kilobytes. Might even be more -- Rex does sometimes increase buffer sizes in a new version.

Thanks -- I found the 8lk value in the header file (*.h) -- Do you know if there is a new SDK for V14?
 

Charles Dye

Super Moderator
Staff member
May 20, 2008
4,466
88
Albuquerque, NM
prospero.unm.edu
Thanks -- I found the 8lk value in the header file (*.h) -- Do you know if there is a new SDK for V14?

Yah, I'm looking at the same thing. He says "8191 characters" but also that it's terminated with a "null byte". So that's a bit confusing. No, I don't think the SDK has been updated for awhile.
 
Similar threads
Thread starter Title Forum Replies Date
fpefpe utf-8 support in sdk/plugin api Plugins 4
Joe Caverly 64-bit Plugin development using PureBasic Plugins 15
R New Plugin Plugins 0
Alpengreis elevated plugin questions Plugins 3
S How to? Can @DU function in 4Utils64 plugin somehow cater for dirs with spaces? Plugins 3
vefatica Plugin access to arrays? Plugins 4
vefatica How big is a plugin's parameter buffer? Plugins 5
C @knownpath plugin Plugins 0
Charles Dye Updated OSD plugin Plugins 0
Joe Caverly C# plugin framework for JPSoft's TCC Plugins 0
dcantor Help for newest version of TEXTUTILS plugin Plugins 10
dcantor UISTUFF plugin missing help topic Plugins 12
M How to? Use SafeChars plugin... Plugins 2
dcantor Error in SAFECHARS plugin v 1.9.0 Plugins 2
dcantor Request for documentation for ISO8601 plugin Plugins 4
vefatica Possible with a plugin? Plugins 6
dcantor Inconsistency between textutils plugin and wrap utility Plugins 2
M (Stupid?) Problem with 64-bit 4Utils plugin... Plugins 3
H Latest ISO8601 plugin? Plugins 1
Charles Dye New plugin: QKeys Plugins 34
S Plugin to quickly locate all files hard linked together Plugins 5
S Documentation Plugin everything.dll Plugins 5
newbie How to? Multi-plugin installation errors, Re: FedUtils8 Plugins 7
vefatica Plugin -> thread -> Command() -> Ctrl-C? Plugins 20
Charles Dye A weirdoid plugin question Plugins 6
M SafeChars plugin misbehaving... Plugins 3
M A weird error re a plugin... Plugins 0
vefatica Plugin dilemma Plugins 2
C Looking for Vince's old 4UTILS plugin for TCMD v8 Plugins 1
S DESKTOP plugin - anyone ? Plugins 0
C How to? a plugin to sort Outlook Express "rules" Plugins 0
M ISO Plugin: Yes, it's wonderful, but it could be yet more wonderful... Plugins 7
M The ISO plugin is wonderful, but it lacks a little something... Plugins 22
Charles Dye Beta plugin: HidePasswords Plugins 3
M ISO8601 Plugin not "reporting" errors to TCC... Plugins 4
Frank 4console plugin Plugins 4
S WAD ISO8601 Plugin Plugins 15
Joe Caverly Plugin and 64-bit TCC Plugins 3
C Problem with FixNames plugin Plugins 9
dcantor Suggestion and request for DBF plugin Plugins 6
dcantor Suggestion for SafeChars plugin Plugins 7
M Charles, I just installed the "new" SafeChars plugin, ... Plugins 5
M A problem with the SafeChars Plugin... Plugins 30
S WHICHWIN (sysutils plugin) Plugins 13
M A (presumbly pretty simple) SafeChars plugin request... Plugins 2
M A "SafeChars" plugin request... Plugins 2
S ISO 8601 plugin enhancement Plugins 6
D UNKNOWN_CMD in Plugin Plugins 13
C Looking for isemailaddress[string] plugin Plugins 7
S ISO8601 Plugin Plugins 4

Similar threads