diff options
Diffstat (limited to 'include')
| -rw-r--r-- | include/m_addcontact.h | 4 | ||||
| -rw-r--r-- | include/m_awaymsg.h | 8 | ||||
| -rw-r--r-- | include/m_clc.h | 102 | ||||
| -rw-r--r-- | include/m_clist.h | 176 | ||||
| -rw-r--r-- | include/m_clui.h | 48 | ||||
| -rw-r--r-- | include/m_database.h | 180 | ||||
| -rw-r--r-- | include/m_email.h | 4 | ||||
| -rw-r--r-- | include/m_file.h | 16 | ||||
| -rw-r--r-- | include/m_findadd.h | 2 | ||||
| -rw-r--r-- | include/m_fuse.h | 4 | ||||
| -rw-r--r-- | include/m_history.h | 4 | ||||
| -rw-r--r-- | include/m_hotkeys.h | 16 | ||||
| -rw-r--r-- | include/m_icq.h | 46 | ||||
| -rw-r--r-- | include/m_ignore.h | 18 | ||||
| -rw-r--r-- | include/m_json.h | 102 | ||||
| -rw-r--r-- | include/m_langpack.h | 28 | ||||
| -rw-r--r-- | include/m_message.h | 22 | ||||
| -rw-r--r-- | include/m_netlib.h | 124 | ||||
| -rw-r--r-- | include/m_options.h | 14 | ||||
| -rw-r--r-- | include/m_popup.h | 6 | ||||
| -rw-r--r-- | include/m_protocols.h | 52 | ||||
| -rw-r--r-- | include/m_protomod.h | 38 | ||||
| -rw-r--r-- | include/m_protosvc.h | 234 | ||||
| -rw-r--r-- | include/m_skin.h | 20 | ||||
| -rw-r--r-- | include/m_system.h | 41 | ||||
| -rw-r--r-- | include/m_system_cpp.h | 6 | ||||
| -rw-r--r-- | include/m_url.h | 4 | ||||
| -rw-r--r-- | include/m_userinfo.h | 20 | ||||
| -rw-r--r-- | include/m_utils.h | 96 | ||||
| -rw-r--r-- | include/m_xml.h | 10 | ||||
| -rw-r--r-- | include/newpluginapi.h | 8 | ||||
| -rw-r--r-- | include/win2k.h | 12 |
32 files changed, 733 insertions, 732 deletions
diff --git a/include/m_addcontact.h b/include/m_addcontact.h index e6c0573821..be0e6a40ee 100644 --- a/include/m_addcontact.h +++ b/include/m_addcontact.h @@ -34,8 +34,8 @@ typedef struct{ /*
Description: Open the add contact dialog, see notes
- wParam=[ (WPARAM)hWndParent ]
- lParam=(LPARAM)(ADDCONTACTSTRUCT*)&acs
+ wParam = [ (WPARAM)hWndParent ]
+ lParam = (LPARAM)(ADDCONTACTSTRUCT*)&acs
Notes:
diff --git a/include/m_awaymsg.h b/include/m_awaymsg.h index 5b2eb974ee..b53ff4f182 100644 --- a/include/m_awaymsg.h +++ b/include/m_awaymsg.h @@ -25,15 +25,15 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #define M_AWAYMSG_H__ 1
//show the away/na/etc message for a contact v0.1.0.1+
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=0
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = 0
//returns 0 on success or nonzero on failure
//returns immediately, without waiting for the message to retrieve
#define MS_AWAYMSG_SHOWAWAYMSG "SRAway/GetMessage"
//returns the default status message for a status
-//wParam=(int)status
-//lParam=(LPARAM)(char*)szProto
+//wParam = (int)status
+//lParam = (LPARAM)(char*)szProto
//returns status msg. Remember to free the return value
#define MS_AWAYMSG_GETSTATUSMSG "SRAway/GetStatusMessage"
#define MS_AWAYMSG_GETSTATUSMSGW "SRAway/GetStatusMessageW"
diff --git a/include/m_clc.h b/include/m_clc.h index 4463b584b9..c71378bf54 100644 --- a/include/m_clc.h +++ b/include/m_clc.h @@ -58,32 +58,32 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #define CLM_LAST 0x1100
//messages, compare with equivalent TVM_s in the MSDN
-#define CLM_ADDCONTACT (CLM_FIRST+0) //wParam=hContact
-#define CLM_ADDGROUP (CLM_FIRST+1) //wParam=hGroup
+#define CLM_ADDCONTACT (CLM_FIRST+0) //wParam = hContact
+#define CLM_ADDGROUP (CLM_FIRST+1) //wParam = hGroup
#define CLM_AUTOREBUILD (CLM_FIRST+2)
-#define CLM_DELETEITEM (CLM_FIRST+3) //wParam=hItem
-#define CLM_EDITLABEL (CLM_FIRST+4) //wParam=hItem
-#define CLM_ENDEDITLABELNOW (CLM_FIRST+5) //wParam=cancel, 0 to save
-#define CLM_ENSUREVISIBLE (CLM_FIRST+6) //wParam=hItem, lParam=partialOk
+#define CLM_DELETEITEM (CLM_FIRST+3) //wParam = hItem
+#define CLM_EDITLABEL (CLM_FIRST+4) //wParam = hItem
+#define CLM_ENDEDITLABELNOW (CLM_FIRST+5) //wParam = cancel, 0 to save
+#define CLM_ENSUREVISIBLE (CLM_FIRST+6) //wParam = hItem, lParam = partialOk
#define CLE_TOGGLE -1
#define CLE_COLLAPSE 0
#define CLE_EXPAND 1
#define CLE_INVALID 0xFFFF
-#define CLM_EXPAND (CLM_FIRST+7) //wParam=hItem, lParam=CLE_
-#define CLM_FINDCONTACT (CLM_FIRST+8) //wParam=hContact, returns an hItem
-#define CLM_FINDGROUP (CLM_FIRST+9) //wParam=hGroup, returns an hItem
+#define CLM_EXPAND (CLM_FIRST+7) //wParam = hItem, lParam = CLE_
+#define CLM_FINDCONTACT (CLM_FIRST+8) //wParam = hContact, returns an hItem
+#define CLM_FINDGROUP (CLM_FIRST+9) //wParam = hGroup, returns an hItem
#define CLM_GETBKCOLOR (CLM_FIRST+10) //returns a COLORREF
-#define CLM_GETCHECKMARK (CLM_FIRST+11) //wParam=hItem, returns 1 or 0
+#define CLM_GETCHECKMARK (CLM_FIRST+11) //wParam = hItem, returns 1 or 0
#define CLM_GETCOUNT (CLM_FIRST+12) //returns the total number of items
#define CLM_GETEDITCONTROL (CLM_FIRST+13) //returns the HWND, or NULL
-#define CLM_GETEXPAND (CLM_FIRST+14) //wParam=hItem, returns a CLE_, CLE_INVALID if not a group
+#define CLM_GETEXPAND (CLM_FIRST+14) //wParam = hItem, returns a CLE_, CLE_INVALID if not a group
#define CLM_GETEXTRACOLUMNS (CLM_FIRST+15) //returns number of extra columns
-#define CLM_GETEXTRAIMAGE (CLM_FIRST+16) //wParam=hItem, lParam=MAKELPARAM(iColumn (0 based),0), returns iImage or 0xFF
+#define CLM_GETEXTRAIMAGE (CLM_FIRST+16) //wParam = hItem, lParam = MAKELPARAM(iColumn (0 based),0), returns iImage or 0xFF
#define CLM_GETEXTRAIMAGELIST (CLM_FIRST+17) //returns HIMAGELIST
-#define CLM_GETFONT (CLM_FIRST+18) //wParam=fontId, see clm_setfont. returns hFont.
-#define CLM_GETINDENT (CLM_FIRST+19) //wParam=new group indent
-#define CLM_GETISEARCHSTRING (CLM_FIRST+20) //lParam=(char*)pszStr, max 120 bytes, returns number of chars in string
-#define CLM_GETITEMTEXT (CLM_FIRST+21) //wParam=hItem, lParam=(TCHAR*)pszStr, max 120 bytes
+#define CLM_GETFONT (CLM_FIRST+18) //wParam = fontId, see clm_setfont. returns hFont.
+#define CLM_GETINDENT (CLM_FIRST+19) //wParam = new group indent
+#define CLM_GETISEARCHSTRING (CLM_FIRST+20) //lParam = (char*)pszStr, max 120 bytes, returns number of chars in string
+#define CLM_GETITEMTEXT (CLM_FIRST+21) //wParam = hItem, lParam = (TCHAR*)pszStr, max 120 bytes
#define CLM_GETSCROLLTIME (CLM_FIRST+22) //returns time in ms
#define CLM_GETSELECTION (CLM_FIRST+23) //returns hItem
#define CLCHT_ABOVE 0x0001 //above client area
@@ -99,8 +99,8 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #define CLCHT_ONITEM 0x03E0
#define CLCHT_INLEFTMARGIN 0x0400
#define CLCHT_BELOWITEMS 0x0800 //in client area but below last item
-#define CLM_HITTEST (CLM_FIRST+25) //lParam=MAKELPARAM(x,y) (relative to control), wParam=(PDWORD)&hitTest (see encoding of HitTest() in clc.h, can be NULL) returns hItem or NULL
-#define CLM_SELECTITEM (CLM_FIRST+26) //wParam=hItem
+#define CLM_HITTEST (CLM_FIRST+25) //lParam = MAKELPARAM(x,y) (relative to control), wParam = (PDWORD)&hitTest (see encoding of HitTest() in clc.h, can be NULL) returns hItem or NULL
+#define CLM_SELECTITEM (CLM_FIRST+26) //wParam = hItem
#define CLB_TOPLEFT 0
#define CLB_STRETCHV 1
#define CLB_STRETCHH 2 //and tile vertically
@@ -110,12 +110,12 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #define CLBF_TILEV 0x2000
#define CLBF_PROPORTIONAL 0x4000
#define CLBF_SCROLL 0x8000
-#define CLM_SETBKBITMAP (CLM_FIRST+27) //wParam=mode, lParam=hBitmap (don't delete it), NULL for none
-#define CLM_SETBKCOLOR (CLM_FIRST+28) //wParam=a COLORREF, default is GetSysColor(COLOR_3DFACE)
-#define CLM_SETCHECKMARK (CLM_FIRST+29) //wParam=hItem, lParam=1 or 0
-#define CLM_SETEXTRACOLUMNS (CLM_FIRST+30) //wParam=number of extra columns (zero to MAXEXTRACOLUMNS from clc.h, currently 16)
-#define CLM_SETEXTRAIMAGE (CLM_FIRST+31) //wParam=hItem, lParam=MAKELPARAM(iColumn (0 based),iImage). iImage=0xFF is a blank
-#define CLM_SETEXTRAIMAGELIST (CLM_FIRST+32) //lParam=HIMAGELIST, wParam=WideImageList
+#define CLM_SETBKBITMAP (CLM_FIRST+27) //wParam = mode, lParam = hBitmap (don't delete it), NULL for none
+#define CLM_SETBKCOLOR (CLM_FIRST+28) //wParam = a COLORREF, default is GetSysColor(COLOR_3DFACE)
+#define CLM_SETCHECKMARK (CLM_FIRST+29) //wParam = hItem, lParam = 1 or 0
+#define CLM_SETEXTRACOLUMNS (CLM_FIRST+30) //wParam = number of extra columns (zero to MAXEXTRACOLUMNS from clc.h, currently 16)
+#define CLM_SETEXTRAIMAGE (CLM_FIRST+31) //wParam = hItem, lParam = MAKELPARAM(iColumn (0 based),iImage). iImage = 0xFF is a blank
+#define CLM_SETEXTRAIMAGELIST (CLM_FIRST+32) //lParam = HIMAGELIST, wParam = WideImageList
#define FONTID_CONTACTS 0
#define FONTID_INVIS 1
@@ -130,24 +130,24 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #define FONTID_CONTACTSHOVER 10
#define FONTID_MAX 18
-#define CLM_SETFONT (CLM_FIRST+33) //wParam=hFont, lParam=MAKELPARAM(fRedraw,fontId)
-#define CLM_SETINDENT (CLM_FIRST+34) //wParam=new indent, default is 3 pixels
-#define CLM_SETITEMTEXT (CLM_FIRST+35) //wParam=hItem, lParam=(char*)pszNewText
-#define CLM_SETSCROLLTIME (CLM_FIRST+36) //wParam=time in ms, default 200
+#define CLM_SETFONT (CLM_FIRST+33) //wParam = hFont, lParam = MAKELPARAM(fRedraw,fontId)
+#define CLM_SETINDENT (CLM_FIRST+34) //wParam = new indent, default is 3 pixels
+#define CLM_SETITEMTEXT (CLM_FIRST+35) //wParam = hItem, lParam = (char*)pszNewText
+#define CLM_SETSCROLLTIME (CLM_FIRST+36) //wParam = time in ms, default 200
-#define CLM_SETHIDEEMPTYGROUPS (CLM_FIRST+38) //wParam=TRUE/FALSE
+#define CLM_SETHIDEEMPTYGROUPS (CLM_FIRST+38) //wParam = TRUE/FALSE
#define GREYF_UNFOCUS 0x80000000
#define MODEF_OFFLINE 0x40000000
//and use the PF2_ #defines from m_protosvc.h
-#define CLM_SETGREYOUTFLAGS (CLM_FIRST+39) //wParam=new flags
+#define CLM_SETGREYOUTFLAGS (CLM_FIRST+39) //wParam = new flags
#define CLM_GETHIDEOFFLINEROOT (CLM_FIRST+40) //returns TRUE/FALSE
-#define CLM_SETHIDEOFFLINEROOT (CLM_FIRST+41) //wParam=TRUE/FALSE
-#define CLM_SETUSEGROUPS (CLM_FIRST+42) //wParam=TRUE/FALSE
-#define CLM_SETOFFLINEMODES (CLM_FIRST+43) //for 'hide offline', wParam=PF2_ flags and MODEF_OFFLINE
+#define CLM_SETHIDEOFFLINEROOT (CLM_FIRST+41) //wParam = TRUE/FALSE
+#define CLM_SETUSEGROUPS (CLM_FIRST+42) //wParam = TRUE/FALSE
+#define CLM_SETOFFLINEMODES (CLM_FIRST+43) //for 'hide offline', wParam = PF2_ flags and MODEF_OFFLINE
#define CLM_GETEXSTYLE (CLM_FIRST+44) //returns CLS_EX_ flags
-#define CLM_SETEXSTYLE (CLM_FIRST+45) //wParam=CLS_EX_ flags
+#define CLM_SETEXSTYLE (CLM_FIRST+45) //wParam = CLS_EX_ flags
#define CLM_GETLEFTMARGIN (CLM_FIRST+46) //returns count of pixels
-#define CLM_SETLEFTMARGIN (CLM_FIRST+47) //wParam=pixels
+#define CLM_SETLEFTMARGIN (CLM_FIRST+47) //wParam = pixels
typedef struct {
int cbSize;
const TCHAR *pszText;
@@ -160,8 +160,8 @@ typedef struct { #define CLCIIF_CHECKBOX 0x40 //give this item a check box
#define CLCIIF_GROUPFONT 0x80 //draw the item using FONTID_GROUPS
-#define CLM_ADDINFOITEMA (CLM_FIRST+48) //lParam=&cii, returns hItem
-#define CLM_ADDINFOITEMW (CLM_FIRST+53) //lParam=&cii, returns hItem
+#define CLM_ADDINFOITEMA (CLM_FIRST+48) //lParam = &cii, returns hItem
+#define CLM_ADDINFOITEMW (CLM_FIRST+53) //lParam = &cii, returns hItem
#if defined(_UNICODE)
#define CLM_ADDINFOITEM CLM_ADDINFOITEMW
#else
@@ -175,7 +175,7 @@ typedef struct { #define CLCIT_CONTACT 1
#define CLCIT_DIVIDER 2
#define CLCIT_INFO 3
-#define CLM_GETITEMTYPE (CLM_FIRST+49) //wParam=hItem, returns a CLCIT_
+#define CLM_GETITEMTYPE (CLM_FIRST+49) //wParam = hItem, returns a CLCIT_
#define CLGN_ROOT 0
#define CLGN_CHILD 1
#define CLGN_PARENT 2
@@ -185,13 +185,13 @@ typedef struct { #define CLGN_PREVIOUSCONTACT 6
#define CLGN_NEXTGROUP 7
#define CLGN_PREVIOUSGROUP 8
-#define CLM_GETNEXTITEM (CLM_FIRST+50) //wParam=flag, lParam=hItem, returns an hItem
-#define CLM_GETTEXTCOLOR (CLM_FIRST+51) //wParam=FONTID_, returns COLORREF
-#define CLM_SETTEXTCOLOR (CLM_FIRST+52) //wParam=FONTID_, lParam=COLORREF
+#define CLM_GETNEXTITEM (CLM_FIRST+50) //wParam = flag, lParam = hItem, returns an hItem
+#define CLM_GETTEXTCOLOR (CLM_FIRST+51) //wParam = FONTID_, returns COLORREF
+#define CLM_SETTEXTCOLOR (CLM_FIRST+52) //wParam = FONTID_, lParam = COLORREF
//DO NOT USE IT EXTERNALLY CAN BE NOT SUPPORTED BY CLIST
-#define CLM_SETWIDEEXTRAIMAGE (CLM_FIRST+60) //wParam=hItem, lParam=MAKELPARAM(iColumn (0 based), iImage). iImage=0xFFFF is a blank
-#define CLM_GETWIDEEXTRAIMAGE (CLM_FIRST+61) //wParam=hItem, lParam=MAKELPARAM(iColumn (0 based), 0), returns iImage or 0xFF
+#define CLM_SETWIDEEXTRAIMAGE (CLM_FIRST+60) //wParam = hItem, lParam = MAKELPARAM(iColumn (0 based), iImage). iImage = 0xFFFF is a blank
+#define CLM_GETWIDEEXTRAIMAGE (CLM_FIRST+61) //wParam = hItem, lParam = MAKELPARAM(iColumn (0 based), 0), returns iImage or 0xFF
#define CLM_GETWIDEEXTRAIMAGELIST (CLM_FIRST+62) //returns HWIDEIMAGELIST
//notifications (most are omitted because the control processes everything)
@@ -206,7 +206,7 @@ typedef struct { POINT pt;
} NMCLISTCONTROL;
#define CLN_FIRST (0U-100U)
-#define CLN_EXPANDED (CLN_FIRST-0) //hItem=hGroup, action=CLE_*
+#define CLN_EXPANDED (CLN_FIRST-0) //hItem = hGroup, action = CLE_*
#define CLN_LISTREBUILT (CLN_FIRST-1)
#define CLN_ITEMCHECKED (CLN_FIRST-2) //todo //hItem, action, flags valid
#define CLN_DRAGGING (CLN_FIRST-3) //hItem, pt, flags valid. only sent when cursor outside window, return nonzero if processed
@@ -221,8 +221,8 @@ typedef struct { //NM_KEYDOWN //NMKEY structure, only sent when key is not already processed, return nonzero to prevent further processing
//an infotip for an item should be shown now
-//wParam=0
-//lParam=(LPARAM)(CLCINFOTIP*)&it
+//wParam = 0
+//lParam = (LPARAM)(CLCINFOTIP*)&it
//Return nonzero if you process this, because it makes no sense for more than
//one plugin to grab it.
//It is up to the plugin to decide the best place to put the infotip. Normally
@@ -252,8 +252,8 @@ typedef struct { #define ME_CLC_SHOWEXTRAINFOTIP "CLC/ShowExtraInfoTip"
//it's time to destroy an infotip
-//wParam=0
-//lParam=(LPARAM)(CLCINFOTIP*)&it
+//wParam = 0
+//lParam = (LPARAM)(CLCINFOTIP*)&it
//Only cbSize, isGroup and hItem are set
//Return nonzero if you process this.
//This is sent when the mouse moves off a contact when clc/showinfotip has
@@ -263,8 +263,8 @@ typedef struct { #define ME_CLC_HIDEINFOTIP "CLC/HideInfoTip"
//set the hover time before the infotip hooks are called
-//wParam=newTime
-//lParam=0
+//wParam = newTime
+//lParam = 0
//Returns 0 on success or nonzero on failure
//The value of this setting is applied to all current CLC windows, and saved
//to be applied to all future windows, including after restarts.
@@ -273,7 +273,7 @@ typedef struct { #define MS_CLC_SETINFOTIPHOVERTIME "CLC/SetInfoTipHoverTime"
//get the hover time before the infotip hooks are called
-//wParam=lParam=0
+//wParam = lParam = 0
//Returns the time in ms
#define MS_CLC_GETINFOTIPHOVERTIME "CLC/GetInfoTipHoverTime"
diff --git a/include/m_clist.h b/include/m_clist.h index 7289f778f2..0536dedc54 100644 --- a/include/m_clist.h +++ b/include/m_clist.h @@ -39,25 +39,25 @@ extern int hLangpack; #endif
//sent when the user asks to change their status
-//wParam=new status, from statusmodes.h
-//lParam=protocol name, NULL if for all protocols (added in v0.3.1alpha)
+//wParam = new status, from statusmodes.h
+//lParam = protocol name, NULL if for all protocols (added in v0.3.1alpha)
//also sent due to a ms_clist_setstatusmode call
#define ME_CLIST_STATUSMODECHANGE "CList/StatusModeChange"
//force a change of status mode
-//wParam=new status, from statusmodes.h
+//wParam = new status, from statusmodes.h
#define MS_CLIST_SETSTATUSMODE "CList/SetStatusMode"
//get the current status mode
-//wParam=lParam=0
+//wParam = lParam = 0
//returns the current status
//This is the status *as set by the user*, not any protocol-specific status
//All protocol modules will attempt to conform to this setting at all times
#define MS_CLIST_GETSTATUSMODE "CList/GetStatusMode"
//gets a textual description of the given status mode (v0.1.0.1+)
-//wParam=status mode, from statusmodes.h
-//lParam=flags, below
+//wParam = status mode, from statusmodes.h
+//lParam = flags, below
//returns a static buffer of the description of the given status mode
//returns NULL if the status mode was unknown
#define GSMDF_PREFIXONLINE 1 //prefix "Online: " to all status modes that
@@ -72,11 +72,11 @@ extern int hLangpack; #define MS_CLIST_GETSTATUSMODEDESCRIPTION "CList/GetStatusModeDescription"
//add a new item to the main menu
-//wParam=0
-//lParam=(LPARAM)(CLISTMENUITEM*)&mi
+//wParam = 0
+//lParam = (LPARAM)(CLISTMENUITEM*)&mi
//returns a handle to the new item, or NULL on failure
//the service that is called when the item is clicked is called with
-//wParam=0, lParam=hwndContactList
+//wParam = 0, lParam = hwndContactList
//dividers are inserted every 100000 positions
//pszContactOwner is ignored for this service.
//there is a #define PUTPOSITIONSINMENU in clistmenus.c which, when set, will
@@ -152,7 +152,7 @@ __inline static HGENMENU Menu_AddMainMenuItem(CLISTMENUITEM *mi) //add a new item to the user contact menus
//identical to clist/addmainmenuitem except when item is selected the service
-//gets called with wParam=(WPARAM)(HANDLE)hContact
+//gets called with wParam = (WPARAM)(HANDLE)hContact
//pszContactOwner is obeyed.
//popup menus are not supported. pszPopupName and popupPosition are ignored.
//If ctrl is held down when right clicking, the menu position numbers will be
@@ -175,8 +175,8 @@ __inline static HGENMENU Menu_AddProtoMenuItem(CLISTMENUITEM *mi) }
//modify an existing menu item v0.1.0.1+
-//wParam=(WPARAM)(HANDLE)hMenuItem
-//lParam=(LPARAM)(CLISTMENUITEM*)&clmi
+//wParam = (WPARAM)(HANDLE)hMenuItem
+//lParam = (LPARAM)(CLISTMENUITEM*)&clmi
//returns 0 on success, nonzero on failure
//hMenuItem will have been returned by clist/add*menuItem
//clmi.flags should contain cmim_ constants below specifying which fields to
@@ -189,17 +189,17 @@ __inline static HGENMENU Menu_AddProtoMenuItem(CLISTMENUITEM *mi) #define MS_CLIST_MODIFYMENUITEM "CList/ModifyMenuItem"
//the context menu for a contact is about to be built v0.1.0.1+
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=0
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = 0
//modules should use this to change menu items that are specific to the
//contact that has them
#define ME_CLIST_PREBUILDCONTACTMENU "CList/PreBuildContactMenu"
//sets the service to call when a contact is double-clicked
-//wParam=0
-//lParam=(LPARAM)(CLISTDOUBLECLICKACTION*)&dca
+//wParam = 0
+//lParam = (LPARAM)(CLISTDOUBLECLICKACTION*)&dca
//contactType is one or more of the constants below
-//pszService is called with wParam=hContact, lParam=0
+//pszService is called with wParam = hContact, lParam = 0
//pszService will only be called if there is no outstanding event on the
//selected contact
//returns 0 on success, nonzero on failure
@@ -220,8 +220,8 @@ typedef struct { #define MS_CLIST_SETDOUBLECLICKACTION "CList/SetDoubleClickAction"
/*
-wParam=(WPARAM)hContact
-lParam=0
+wParam = (WPARAM)hContact
+lParam = 0
Event is fired when there is a double click on a CList contact,
it is upto the caller to check for the protocol & status
@@ -231,8 +231,8 @@ sense to store all this information in memory, etc. */
#define ME_CLIST_DOUBLECLICKED "CList/DoubleClicked"
//gets the string that the contact list will use to represent a contact
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=flags
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = flags
//returns a pointer to the name, will always succeed, even if it needs to
//return "(Unknown Contact)"
//this pointer is to a statically allocated buffer which will be overwritten
@@ -253,19 +253,19 @@ sense to store all this information in memory, etc. #define MS_CLIST_GETCONTACTDISPLAYNAME "CList/GetContactDisplayName"
// Invalidates the display name cache
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=not used
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = not used
#define MS_CLIST_INVALIDATEDISPLAYNAME "CList/InvalidateDiplayName"
//adds an event to the contact list's queue
-//wParam=0
-//lParam=(LPARAM)(CLISTEVENT*)cle
+//wParam = 0
+//lParam = (LPARAM)(CLISTEVENT*)cle
//The contact list will flash hIcon next to the contact hContact (use NULL for
//a system message). szServiceName will be called when the user double clicks
//the icon, at which point the event will be removed from the contact list's
//queue automatically
-//pszService is called with wParam=(WPARAM)(HWND)hwndContactList,
-//lParam=(LPARAM)(CLISTEVENT*)cle. Its return value is ignored. cle is
+//pszService is called with wParam = (WPARAM)(HWND)hwndContactList,
+//lParam = (LPARAM)(CLISTEVENT*)cle. Its return value is ignored. cle is
//invalidated when your service returns, so take copies of any important
//information in it.
//hDbEvent should be unique since it and hContact are the identifiers used by
@@ -306,19 +306,19 @@ typedef struct { #define MS_CLIST_ADDEVENT "CList/AddEvent"
//removes an event from the contact list's queue
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=(LPARAM)(HANDLE)hDbEvent
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = (LPARAM)(HANDLE)hDbEvent
//returns 0 if the event was successfully removed, or nonzero if the event
//was not found
#define MS_CLIST_REMOVEEVENT "Clist/RemoveEvent"
//gets the details of an event in the queue v0.1.2.1+
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=iEvent
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = iEvent
//returns a CLISTEVENT* on success, NULL on failure
-//Returns the iEvent-th event from the queue for hContact, so iEvent=0 will
+//Returns the iEvent-th event from the queue for hContact, so iEvent = 0 will
//get the event that will be got when the user clicks on that contact.
-//Use hContact=INVALID_HANDLE_VALUE to search over all contacts, so iEvent=0
+//Use hContact = INVALID_HANDLE_VALUE to search over all contacts, so iEvent = 0
//will get the event that will be got if the user clicks the systray icon.
#define MS_CLIST_GETEVENT "CList/GetEvent"
@@ -335,14 +335,14 @@ typedef struct { #define MS_CLIST_MENUDRAWITEM "CList/MenuDrawItem"
//builds the context menu for a specific contact v0.1.1.0+
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=0
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = 0
//returns a HMENU identifying the menu. This should be DestroyMenu()ed when
//finished with.
#define MS_CLIST_MENUBUILDCONTACT "CList/MenuBuildContact"
//gets the image list with all the useful icons in it v0.1.1.0+
-//wParam=lParam=0
+//wParam = lParam = 0
//returns a HIMAGELIST
//the members of this image list are opaque, and you should trust what you
//are given
@@ -351,16 +351,16 @@ typedef struct { #define IMAGE_GROUPSHUT 12
//get the icon that should be associated with a contact v0.1.2.0+
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=0
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = 0
//returns an index into the contact list imagelist. See clist/geticonsimagelist
//If the contact is flashing an icon, this function will not return that
//flashing icon. Use me_clist_contacticonchanged to get info about that.
#define MS_CLIST_GETCONTACTICON "CList/GetContactIcon"
//The icon of a contact in the contact list has changed v0.1.2.0+
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=iconId
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = iconId
//iconId is an offset into the clist's imagelist. See clist/geticonsimagelist
#define ME_CLIST_CONTACTICONCHANGED "CList/ContactIconChanged"
@@ -369,12 +369,12 @@ typedef struct { // Stuff below here is ideally for the use of a CList UI module only.
//get a handle to the main Miranda menu v0.1.1.0+
-//wParam=lParam=0
+//wParam = lParam = 0
//returns a HMENU. This need not be freed since it's owned by clist
#define MS_CLIST_MENUGETMAIN "CList/MenuGetMain"
//get a handle to the Miranda status menu v0.1.1.0+
-//wParam=lParam=0
+//wParam = lParam = 0
//returns a HMENU. This need not be freed since it's owned by clist
#define MS_CLIST_MENUGETSTATUS "CList/MenuGetStatus"
@@ -382,8 +382,8 @@ typedef struct { //processes a menu selection from a menu v0.1.1.0+
-//wParam=MAKEWPARAM(LOWORD(wParam from WM_COMMAND), flags)
-//lParam=(LPARAM)(HANDLE)hContact
+//wParam = MAKEWPARAM(LOWORD(wParam from WM_COMMAND), flags)
+//lParam = (LPARAM)(HANDLE)hContact
//returns TRUE if it processed the command, FALSE otherwise
//hContact is the currently selected contact. It it not used if this is a main
//menu command. If this is NULL and the command is a contact menu one, the
@@ -411,48 +411,48 @@ typedef struct { #define MS_CLIST_MENUPROCESSCOMMAND "CList/MenuProcessCommand"
//processes a menu hotkey v0.1.1.0+
-//wParam=virtual key code
-//lParam=MPCF_ flags
+//wParam = virtual key code
+//lParam = MPCF_ flags
//returns TRUE if it processed the command, FALSE otherwise
//this should be called in WM_KEYDOWN
#define MS_CLIST_MENUPROCESSHOTKEY "CList/MenuProcessHotkey"
//process all the messages required for docking v0.1.1.0+
-//wParam=(WPARAM)(MSG*)&msg
-//lParam=(LPARAM)(LRESULT*)&lResult
+//wParam = (WPARAM)(MSG*)&msg
+//lParam = (LPARAM)(LRESULT*)&lResult
//returns TRUE if the message should not be processed further, FALSE otherwise
//only msg.hwnd, msg.message, msg.wParam and msg.lParam are used
//your wndproc should return lResult if and only if TRUE is returned
#define MS_CLIST_DOCKINGPROCESSMESSAGE "CList/DockingProcessMessage"
//determines whether the contact list is docked v0.1.1.0+
-//wParam=lParam=0
+//wParam = lParam = 0
//returns nonzero if the contact list is docked, of 0 if it is not
#define MS_CLIST_DOCKINGISDOCKED "CList/DockingIsDocked"
//process all the messages required for the tray icon v0.1.1.0+
-//wParam=(WPARAM)(MSG*)&msg
-//lParam=(LPARAM)(LRESULT*)&lResult
+//wParam = (WPARAM)(MSG*)&msg
+//lParam = (LPARAM)(LRESULT*)&lResult
//returns TRUE if the message should not be processed further, FALSE otherwise
//only msg.hwnd, msg.message, msg.wParam and msg.lParam are used
//your wndproc should return lResult if and only if TRUE is returned
#define MS_CLIST_TRAYICONPROCESSMESSAGE "CList/TrayIconProcessMessage"
//process all the messages required for hotkeys v0.1.1.0+
-//wParam=(WPARAM)(MSG*)&msg
-//lParam=(LPARAM)(LRESULT*)&lResult
+//wParam = (WPARAM)(MSG*)&msg
+//lParam = (LPARAM)(LRESULT*)&lResult
//returns TRUE if the message should not be processed further, FALSE otherwise
//only msg.hwnd, msg.message, msg.wParam and msg.lParam are used
//your wndproc should return lResult if and only if TRUE is returned
#define MS_CLIST_HOTKEYSPROCESSMESSAGE "CList/HotkeysProcessMessage"
//toggles the show/hide status of the contact list v0.1.1.0+
-//wParam=lParam=0
+//wParam = lParam = 0
//returns 0 on success, nonzero on failure
#define MS_CLIST_SHOWHIDE "CList/ShowHide"
//temporarily disable the autohide feature v0.1.2.1+
-//wParam=lParam=0
+//wParam = lParam = 0
//returns 0 on success, nonzero on failure
//This service will restart the autohide timer, so if you need to keep the
//window visible you'll have to be getting user input regularly and calling
@@ -461,8 +461,8 @@ typedef struct { //sent when the group get modified (created, renamed or deleted)
//or contact is moving from group to group
-//wParam=hContact - NULL if operation on group
-//lParam=pointer to CLISTGROUPCHANGE
+//wParam = hContact - NULL if operation on group
+//lParam = pointer to CLISTGROUPCHANGE
typedef struct {
int cbSize; //size in bytes of this structure
TCHAR* pszOldName; //old group name
@@ -472,8 +472,8 @@ typedef struct { #define ME_CLIST_GROUPCHANGE "CList/GroupChange"
//creates a new group and calls CLUI to display it v0.1.1.0+
-//wParam=hParentGroup
-//lParam=groupName
+//wParam = hParentGroup
+//lParam = groupName
//returns a handle to the new group
//hParentGroup is NULL to create the new group at the root, or can be the
//handle of the group of which the new group should be a subgroup.
@@ -482,30 +482,30 @@ typedef struct { #define MS_CLIST_GROUPCREATE "CList/GroupCreate"
//deletes a group and calls CLUI to display the change v0.1.1.0+
-//wParam=(WPARAM)(HANDLE)hGroup
-//lParam=0
+//wParam = (WPARAM)(HANDLE)hGroup
+//lParam = 0
//returns 0 on success, nonzero on failure
#define MS_CLIST_GROUPDELETE "CList/GroupDelete"
//change the expanded state flag for a group internally v0.1.1.0+
-//wParam=(WPARAM)(HANDLE)hGroup
-//lParam=newState
+//wParam = (WPARAM)(HANDLE)hGroup
+//lParam = newState
//returns 0 on success, nonzero on failure
//newState is nonzero if the group is expanded, 0 if it's collapsed
//CLUI is not called when this change is made
#define MS_CLIST_GROUPSETEXPANDED "CList/GroupSetExpanded"
//changes the flags for a group v0.1.2.1+
-//wParam=(WPARAM)(HANDLE)hGroup
-//lParam=MAKELPARAM(flags, flagsMask)
+//wParam = (WPARAM)(HANDLE)hGroup
+//lParam = MAKELPARAM(flags, flagsMask)
//returns 0 on success, nonzero on failure
//Only the flags given in flagsMask are altered.
//CLUI is called on changes to GROUPF_HIDEOFFLINE.
#define MS_CLIST_GROUPSETFLAGS "CList/GroupSetFlags"
//get the name of a group v0.1.1.0+
-//wParam=(WPARAM)(HANDLE)hGroup
-//lParam=(LPARAM)(int*)&isExpanded
+//wParam = (WPARAM)(HANDLE)hGroup
+//lParam = (LPARAM)(int*)&isExpanded
//returns a static buffer pointing to the name of the group
//returns NULL if hGroup is invalid.
//this buffer is only valid until the next call to this service
@@ -514,8 +514,8 @@ typedef struct { #define MS_CLIST_GROUPGETNAME "CList/GroupGetName"
//get the name of a group v0.1.2.1+
-//wParam=(WPARAM)(HANDLE)hGroup
-//lParam=(LPARAM)(DWORD*)&flags
+//wParam = (WPARAM)(HANDLE)hGroup
+//lParam = (LPARAM)(DWORD*)&flags
//returns a static buffer pointing to the name of the group
//returns NULL if hGroup is invalid.
//this buffer is only valid until the next call to this service
@@ -525,8 +525,8 @@ typedef struct { #define MS_CLIST_GROUPGETNAME2 "CList/GroupGetName2"
//move a group to directly before another group v0.1.2.1+
-//wParam=(WPARAM)(HANDLE)hGroup
-//lParam=(LPARAM)(HANDLE)hBeforeGroup
+//wParam = (WPARAM)(HANDLE)hGroup
+//lParam = (LPARAM)(HANDLE)hBeforeGroup
//returns the new handle of the group on success, NULL on failure
//The order is represented by the order in which MS_CLUI_GROUPADDED is called,
//however UIs are free to ignore this order and sort alphabetically if they
@@ -534,16 +534,16 @@ typedef struct { #define MS_CLIST_GROUPMOVEBEFORE "CList/GroupMoveBefore"
//rename a group internally v0.1.1.0+
-//wParam=(WPARAM)(HANDLE)hGroup
-//lParam=(LPARAM)(char*)szNewName
+//wParam = (WPARAM)(HANDLE)hGroup
+//lParam = (LPARAM)(char*)szNewName
//returns 0 on success, nonzero on failure
//this will fail if the group name is a duplicate of an existing name
//CLUI is not called when this change is made
#define MS_CLIST_GROUPRENAME "CList/GroupRename"
//build a menu of the group tree v0.1.2.1+
-//wParam=0
-//lParam=0
+//wParam = 0
+//lParam = 0
//returns a HMENU on success, or NULL on failure
//The return value must be DestroyMenu()ed when you're done with it.
//NULL will be returned if the user doesn't have any groups
@@ -552,44 +552,44 @@ typedef struct { #define MS_CLIST_GROUPBUILDMENU "CList/GroupBuildMenu"
//changes the 'hide offline contacts' flag and call CLUI v0.1.1.0+
-//wParam=newValue
-//lParam=0
+//wParam = newValue
+//lParam = 0
//returns 0 on success, nonzero on failure
//newValue is 0 to show all contacts, 1 to only show online contacts
//or -1 to toggle the value
#define MS_CLIST_SETHIDEOFFLINE "CList/SetHideOffline"
//do the message processing associated with double clicking a contact v0.1.1.0+
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=0
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = 0
//returns 0 on success, nonzero on failure
#define MS_CLIST_CONTACTDOUBLECLICKED "CList/ContactDoubleClicked"
//do the processing for when some files are dropped on a contact v0.1.2.1+
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=(LPARAM)(char**)ppFiles
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = (LPARAM)(char**)ppFiles
//returns 0 on success, nonzero on failure
//ppFiles is an array of fully qualified filenames, ending with a NULL.
#define MS_CLIST_CONTACTFILESDROPPED "CList/ContactFilesDropped"
//change the group a contact belongs to v0.1.1.0+
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=(LPARAM)(HANDLE)hGroup
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = (LPARAM)(HANDLE)hGroup
//returns 0 on success, nonzero on failure
-//use hGroup=NULL to put the contact in no group
+//use hGroup = NULL to put the contact in no group
#define MS_CLIST_CONTACTCHANGEGROUP "CList/ContactChangeGroup"
//determines the ordering of two contacts v0.1.1.0+
-//wParam=(WPARAM)(HANDLE)hContact1
-//lParam=(LPARAM)(HANDLE)hContact2
+//wParam = (WPARAM)(HANDLE)hContact1
+//lParam = (LPARAM)(HANDLE)hContact2
//returns 0 if hContact1 is the same as hContact2
//returns +1 if hContact2 should be displayed after hContact1
//returns -1 if hContact1 should be displayed after hContact2
#define MS_CLIST_CONTACTSCOMPARE "CList/ContactsCompare"
/*
- wParam=0 (not used)
- lParam=(LPARAM) &MIRANDASYSTRAYNOTIFY
+ wParam = 0 (not used)
+ lParam = (LPARAM) &MIRANDASYSTRAYNOTIFY
Affects: Show a message in a ballon tip against a protocol icon (if installed)
Returns: 0 on success, non zero on failure
diff --git a/include/m_clui.h b/include/m_clui.h index c02d8ed26c..9b4ae4977b 100644 --- a/include/m_clui.h +++ b/include/m_clui.h @@ -29,7 +29,7 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. //ui/contactlist/m_clist.h instead
//gets the handle for the contact list window
-//wParam=lParam=0
+//wParam = lParam = 0
//returns the HWND
//This call has a few very specific purposes internally in Miranda, and
//shouldn't be gratuitously used. In almost all cases there's another call to
@@ -40,16 +40,16 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #define MS_CLUI_GETHWNDTREE "CLUI/GetHwndTree"
//change protocol-specific status indicators
-//wParam=new status
-//lParam=(LPARAM)(const char*)szProtocolID
+//wParam = new status
+//lParam = (LPARAM)(const char*)szProtocolID
//returns 0 on success, nonzero on failure
//protocol modules don't want to call this. They want
//clist/protocolstatuschanged instead
#define MS_CLUI_PROTOCOLSTATUSCHANGED "CLUI/ProtocolStatusChanged"
//a new group was created. Add it to the list
-//wParam=(WPARAM)(HANDLE)hGroup
-//lParam=newGroup
+//wParam = (WPARAM)(HANDLE)hGroup
+//lParam = newGroup
//returns 0 on success, nonzero on failure
//newGroup is set to 1 if the user just created the group, and 0 otherwise
//this is also called when the contact list is being rebuilt
@@ -57,23 +57,23 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #define MS_CLUI_GROUPADDED "CLUI/GroupCreated"
//change the icon for a contact
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=iconid
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = iconid
//returns 0 on sucess, nonzero on failure
//iconid is an offset in the image list. see clist/geticonsimagelist
#define MS_CLUI_CONTACTSETICON "CLUI/ContactSetIcon"
//remove a contact from the list
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=0
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = 0
//returns 0 on success, nonzero on failure
//this is not necessarily the same as a contact being actually deleted, since
//if a contact goes offline while 'hide offline' is on, this will be called
#define MS_CLUI_CONTACTDELETED "CLUI/ContactDeleted"
//add a contact to the list
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=iconId
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = iconId
//returns 0 on success, nonzero on failure
//The caller processes the 'hide offline' setting, so the callee should not do
//further processing based on the value of this setting.
@@ -90,8 +90,8 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #define MS_CLUI_CONTACTADDED "CLUI/ContactAdded"
//rename a contact in the list
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=0
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = 0
//returns 0 on success, nonzero on failure
//you should not re-sort the list on this call. A separate resort request will
//be sent
@@ -99,7 +99,7 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #define MS_CLUI_CONTACTRENAMED "CLUI/ContactRenamed"
//start a rebuild of the contact list
-//wParam=lParam=0
+//wParam = lParam = 0
//returns 0 on success, nonzero on failure
//this is the cue to clear the existing contents of the list
//expect to get a series of clui/groupadded calls followed by a series of
@@ -107,22 +107,22 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #define MS_CLUI_LISTBEGINREBUILD "CLUI/ListBeginRebuild"
//end a rebuild of the contact list
-//wParam=lParam=0
+//wParam = lParam = 0
//returns 0 on success, nonzero on failure
//if you displayed an hourglass in beginrebuild, set it back here
//you do not need to explicitly sort the list
#define MS_CLUI_LISTENDREBUILD "CLUI/ListEndRebuild"
//sort the contact list now
-//wParam=lParam=0
+//wParam = lParam = 0
//returns 0 on success, nonzero on failure
//sorts are buffered so you won't get this message lots of times if the list
//needs to be re-sorted many times rapidly.
#define MS_CLUI_SORTLIST "CLUI/SortList"
//Gets a load of capabilities for the loaded CLUI v0.1.2.1+
-//wParam=capability, CLUICAPS_*
-//lParam=0
+//wParam = capability, CLUICAPS_*
+//lParam = 0
//returns the requested value, 0 if wParam is an unknown value
//If this service is not implemented, it is assumed to return 0 to all input
@@ -157,21 +157,21 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #define MS_CLUI_GETCAPS "CLUI/GetCaps"
//a contact is being dragged outside the main window v0.1.2.0+
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=MAKELPARAM(screenX, screenY)
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = MAKELPARAM(screenX, screenY)
//return nonzero to make the cursor a 'can drop here', or zero for 'no'
#define ME_CLUI_CONTACTDRAGGING "CLUI/ContactDragging"
//a contact has just been dropped outside the main window v0.1.2.0+
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=MAKELPARAM(screenX, screenY)
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = MAKELPARAM(screenX, screenY)
//return nonzero if your hook processed this, so no other hooks get it
#define ME_CLUI_CONTACTDROPPED "CLUI/ContactDropped"
//a contact that was being dragged outside the main window has gone back in to
//the main window. v0.1.2.1+
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=0
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = 0
//return zero
#define ME_CLUI_CONTACTDRAGSTOP "CLUI/ContactDragStop"
diff --git a/include/m_database.h b/include/m_database.h index 2dc03a5ff6..9fcce5bd8d 100644 --- a/include/m_database.h +++ b/include/m_database.h @@ -89,8 +89,8 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. /* DB/Contact/GetProfileName service
Gets the name of the profile currently being used by the database module. This
is the same as the filename of the database
- wParam=(WPARAM)(UINT)cbName
- lParam=(LPARAM)(char*)pszName
+ wParam = (WPARAM)(UINT)cbName
+ lParam = (LPARAM)(char*)pszName
pszName is a pointer to the buffer that receives the name of the profile
cbName is the size in bytes of the pszName buffer
Returns 0 on success or nonzero otherwise
@@ -103,8 +103,8 @@ Get the path of the base folder where Miranda will store all individual profiles The returned path does NOT include a trailing backslash.
Essentially this is what has been set in mirandaboot.ini as ProfileDir.
For more options to retrieve profile paths check MS_UTILS_REPLACEVARS
- wParam=(WPARAM)(UINT)cbName
- lParam=(LPARAM)(char*)pszName
+ wParam = (WPARAM)(UINT)cbName
+ lParam = (LPARAM)(char*)pszName
pszName is a pointer to the buffer that receives the path of the profile
cbName is the size in bytes of the pszName buffer
Returns 0 on success or nonzero otherwise
@@ -124,8 +124,8 @@ Returns 0 on success or nonzero otherwise /* DB/Contact/GetSetting service
Look up the value of a named setting for a specific contact in the database
- wParam=(WPARAM)(HANDLE)hContact
- lParam=(LPARAM)(DBCONTACTGETSETTING*)&dbcgs
+ wParam = (WPARAM)(HANDLE)hContact
+ lParam = (LPARAM)(DBCONTACTGETSETTING*)&dbcgs
hContact should have been returned by find*contact or addcontact
Caller is responsible for free()ing dbcgs.pValue->pszVal and pbVal if they are
returned. This should be done with db/contact/freevariant if you have your own
@@ -163,8 +163,8 @@ the dbcgs->type parameter /* DB/Contact/GetSettingStatic service
Look up the value of a named setting for a specific contact in the database
- wParam=(WPARAM)(HANDLE)hContact
- lParam=(LPARAM)(DBCONTACTGETSETTING*)&dbcgs
+ wParam = (WPARAM)(HANDLE)hContact
+ lParam = (LPARAM)(DBCONTACTGETSETTING*)&dbcgs
hContact should have been returned by find*contact or addcontact
This service differs from db/contact/getsetting in that it won't malloc()
memory for the return value if it needs to do so. This introduces some extra
@@ -191,8 +191,8 @@ was invalid. /* DB/Contact/FreeVariant service
Free the memory in a DBVARIANT that is allocated by a call to
db/contact/getsetting
- wParam=0
- lParam=(LPARAM)(DBVARIANT*)&dbv
+ wParam = 0
+ lParam = (LPARAM)(DBVARIANT*)&dbv
Returns 0 on success, nonzero otherwise
This service is actually just a wrapper around a call to free() and a test to
check that it is a string or a blob in the variant. It exists because DLLs have
@@ -209,8 +209,8 @@ There's a helper function for this at the bottom of this header too. /* DB/Contact/WriteSetting service
Change the value of, or create a new value with, a named setting for a specific
contact in the database to the given value
- wParam=(WPARAM)(HANDLE)hContact
- lParam=(LPARAM)(DBCONTACTWRITESETTING*)&dbcws
+ wParam = (WPARAM)(HANDLE)hContact
+ lParam = (LPARAM)(DBCONTACTWRITESETTING*)&dbcws
hContact should have been returned by find*contact or addcontact
Returns 0 on success or nonzero if hContact was invalid
Note that DBCONTACTGETSETTING takes a pointer to a DBVARIANT, whereas
@@ -229,14 +229,14 @@ typedef struct { /* DB/Contact/DeleteSetting service
Removes a named setting for a specific contact from the database
- wParam=(WPARAM)(HANDLE)hContact
- lParam=(LPARAM)(DBCONTACTGETSETTING*)&dbcgs
+ wParam = (WPARAM)(HANDLE)hContact
+ lParam = (LPARAM)(DBCONTACTGETSETTING*)&dbcgs
hContact should have been returned by find*contact or addcontact
pValue from dbcgs is not used.
Returns 0 on success or nonzero if the setting was not present or hContact was
invalid
Triggers a db/contact/settingchanged event before it deletes the setting. The
-'new value' of the setting is set to type=0 and all the other fields are
+'new value' of the setting is set to type = 0 and all the other fields are
undefined.
*/
#define MS_DB_CONTACT_DELETESETTING "DB/Contact/DeleteSetting"
@@ -244,8 +244,8 @@ undefined. /* db/contact/enumsettings v0.1.0.1+
Lists all the settings a specific modules has stored in the database for a
specific contact.
-wParam=(WPARAM)(HANDLE)hContact
-lParam=(LPARAM)(DBCONTACTENUMSETTINGS*)&dbces
+wParam = (WPARAM)(HANDLE)hContact
+lParam = (LPARAM)(DBCONTACTENUMSETTINGS*)&dbces
Returns the return value of the last call to pfnEnumProc, or -1 if there are
no settings for that module/contact pair
Writing to or deleting from the database while enumerating will have
@@ -266,7 +266,7 @@ typedef struct { /* DB/Contact/GetCount service
Gets the number of contacts in the database, which does not count the user
- wParam=lParam=0
+ wParam = lParam = 0
Returns the number of contacts. They can be retrieved using contact/findfirst
and contact/findnext
*/
@@ -275,7 +275,7 @@ and contact/findnext /* DB/Contact/FindFirst service
Gets the handle of the first contact in the database. This handle can be used
with loads of functions. It does not need to be closed.
- wParam=lParam=0
+ wParam = lParam = 0
Returns a handle to the first contact in the db on success, or NULL if there
are no contacts in the db.
*/
@@ -284,8 +284,8 @@ are no contacts in the db. /* DB/Contact/FindNext service
Gets the handle of the next contact after hContact in the database. This handle
can be used with loads of functions. It does not need to be closed.
- wParam=(WPARAM)(HANDLE)hContact
- lParam=0
+ wParam = (WPARAM)(HANDLE)hContact
+ lParam = 0
Returns a handle to the contact after hContact in the db on success or NULL if
hContact was the last contact in the db or hContact was invalid.
*/
@@ -294,10 +294,10 @@ hContact was the last contact in the db or hContact was invalid. /* DB/Contact/Delete
Deletes the contact hContact from the database and all events and settings
associated with it.
- wParam=(WPARAM)(HANDLE)hContact
- lParam=0
+ wParam = (WPARAM)(HANDLE)hContact
+ lParam = 0
Returns 0 on success or nonzero if hContact was invalid
-Please don't try to delete the user contact (hContact=NULL)
+Please don't try to delete the user contact (hContact = NULL)
Triggers a db/contact/deleted event just *before* it removes anything
Because all events are deleted, lots of people may end up with invalid event
handles from this operation, which they should be prepared for.
@@ -307,7 +307,7 @@ handles from this operation, which they should be prepared for. /* DB/Contact/Add
Adds a new contact to the database. New contacts initially have no settings
whatsoever, they must all be added with db/contacts/writesetting.
- wParam=lParam=0
+ wParam = lParam = 0
Returns a handle to the newly created contact on success, or NULL otherwise.
Triggers a db/contact/added event just before it returns.
*/
@@ -317,8 +317,8 @@ Triggers a db/contact/added event just before it returns. Checks if a given value is a valid contact handle, note that due
to the nature of multiple threading, a valid contact can still become
invalid after a call to this service.
- wParam=(WPARAM)hContact
- lParam=0
+ wParam = (WPARAM)hContact
+ lParam = 0
Returns 1 if the contact is a contact, or 0 if the contact is not valid.
*/
#define MS_DB_CONTACT_IS "DB/Contact/Is"
@@ -332,8 +332,8 @@ will be called. For example, for module named 'foo' and event id 2000 a service foo/GetEventText2000 should be defined to process this request. That handler should
decode a blob and return the event text in the required format, its prototype is identical
to a call of MS_DB_EVENT_GETTEXT (see below)
- wParam=0
- lParam=(LPARAM)(DBEVENTTYPEDESCR*)
+ wParam = 0
+ lParam = (LPARAM)(DBEVENTTYPEDESCR*)
Always returns 0.
*/
@@ -363,8 +363,8 @@ typedef struct /* DB/EventType/Get service (0.7+)
Retrieves the previously registered database event type, by module & id.
- wParam=(WPARAM)(char*)szModule
- lParam=(LPARAM)(int)eventType
+ wParam = (WPARAM)(char*)szModule
+ lParam = (LPARAM)(int)eventType
Returns DBEVENTTYPEDESCR* or NULL, if an event isn't found.
*/
@@ -372,8 +372,8 @@ Returns DBEVENTTYPEDESCR* or NULL, if an event isn't found. /* DB/Event/GetCount service
Gets the number of events in the chain belonging to a contact in the database.
- wParam=(WPARAM)(HANDLE)hContact
- lParam=0
+ wParam = (WPARAM)(HANDLE)hContact
+ lParam = 0
Returns the number of events in the chain owned by hContact or -1 if hContact
is invalid. They can be retrieved using the event/find* services.
*/
@@ -381,8 +381,8 @@ is invalid. They can be retrieved using the event/find* services. /* DB/Event/Add
Adds a new event to a contact's event list
- wParam=(WPARAM)(HANDLE)hContact
- lParam=(LPARAM)(DBEVENTINFO*)&dbe
+ wParam = (WPARAM)(HANDLE)hContact
+ lParam = (LPARAM)(DBEVENTINFO*)&dbe
Returns a handle to the newly added event, or NULL on failure
Triggers a db/event/added event just before it returns.
Events are sorted chronologically as they are entered, so you cannot guarantee
@@ -426,8 +426,8 @@ typedef struct { /* DB/Event/Delete
Removes a single event from the database
- wParam=(WPARAM)(HANDLE)hContact
- lParam=(LPARAM)(HANDLE)hDbEvent
+ wParam = (WPARAM)(HANDLE)hContact
+ lParam = (LPARAM)(HANDLE)hDbEvent
hDbEvent should have been returned by db/event/add or db/event/find*event
Returns 0 on success, or nonzero if hDbEvent was invalid
Triggers a db/event/deleted event just *before* the event is deleted
@@ -436,8 +436,8 @@ Triggers a db/event/deleted event just *before* the event is deleted /* DB/Event/GetBlobSize
Retrieves the space in bytes required to store the blob in hDbEvent
- wParam=(WPARAM)(HANDLE)hDbEvent
- lParam=0
+ wParam = (WPARAM)(HANDLE)hDbEvent
+ lParam = 0
hDbEvent should have been returned by db/event/add or db/event/find*event
Returns the space required in bytes, or -1 if hDbEvent is invalid
*/
@@ -445,8 +445,8 @@ Returns the space required in bytes, or -1 if hDbEvent is invalid /* DB/Event/Get
Retrieves all the information stored in hDbEvent
- wParam=(WPARAM)(HANDLE)hDbEvent
- lParam=(LPARAM)(DBEVENTINFO*)&dbe
+ wParam = (WPARAM)(HANDLE)hDbEvent
+ lParam = (LPARAM)(DBEVENTINFO*)&dbe
hDbEvent should have been returned by db/event/add or db/event/find*event
Returns 0 on success or nonzero if hDbEvent is invalid
Don't forget to set dbe.cbSize, dbe.pBlob and dbe.cbBlob before calling this
@@ -463,8 +463,8 @@ of modules. Look but don't touch. /* DB/Event/GetText (0.7.0+)
Retrieves the event's text
- wParam=(WPARAM)0 (unused)
- lParam=(LPARAM)(DBEVENTGETTEXT*)egt - pointer to structure with parameters
+ wParam = (WPARAM)0 (unused)
+ lParam = (LPARAM)(DBEVENTGETTEXT*)egt - pointer to structure with parameters
egt->dbei should be the valid database event read via MS_DB_EVENT_GET
egt->datatype = DBVT_WCHAR or DBVT_ASCIIZ or DBVT_TCHAR. If a caller wants to
suppress Unicode part of event in answer, add DBVTF_DENYUNICODE to this field.
@@ -498,8 +498,8 @@ __inline static TCHAR* DbGetEventTextT(DBEVENTINFO* dbei, int codepage) /* DB/Event/GetIcon (0.7.0.1+)
Retrieves the event's icon
- wParam=(WPARAM)(int)flags - use LR_SHARED for shared HICON
- lParam=(LPARAM)(DBEVENTINFO*)dbei
+ wParam = (WPARAM)(int)flags - use LR_SHARED for shared HICON
+ lParam = (LPARAM)(DBEVENTINFO*)dbei
dbei should be a valid database event read via MS_DB_EVENT_GET
Function returns HICON (use DestroyIcon to release resources if not LR_SHARED)
@@ -514,8 +514,8 @@ same parameters MS_DB_EVENT_GETICON does. /* DB/Event/GetString (0.9.0+)
Converts the event's string to TCHAR* depending on the event's format
- wParam=(LPARAM)(DBEVENTINFO*)dbei
- lParam=(WPARAM)(char*)str - string to be converted
+ wParam = (LPARAM)(DBEVENTINFO*)dbei
+ lParam = (WPARAM)(char*)str - string to be converted
returns TCHAR* - the converted string
Caller must free the result using mir_free
*/
@@ -529,8 +529,8 @@ __inline static TCHAR* DbGetEventStringT(DBEVENTINFO* dbei, const char* str) /* DB/Event/MarkRead
Changes the flags for an event to mark it as read.
- wParam=(WPARAM)(HANDLE)hContact
- lParam=(LPARAM)(HANDLE)hDbEvent
+ wParam = (WPARAM)(HANDLE)hContact
+ lParam = (LPARAM)(HANDLE)hDbEvent
hDbEvent should have been returned by db/event/add or db/event/find*event
Returns the entire flag DWORD for the event after the change, or -1 if hDbEvent
is invalid.
@@ -541,8 +541,8 @@ Modules should not save flags states for any length of time. /* DB/Event/GetContact
Retrieves a handle to the contact that owns hDbEvent.
- wParam=(WPARAM)(HANDLE)hDbEvent
- lParam=0
+ wParam = (WPARAM)(HANDLE)hDbEvent
+ lParam = 0
hDbEvent should have been returned by db/event/add or db/event/find*event
NULL is a valid return value, meaning, as usual, the user.
Returns (HANDLE)(-1) if hDbEvent is invalid, or the handle to the contact on
@@ -554,8 +554,8 @@ all. /* DB/Event/FindFirst
Retrieves a handle to the first event in the chain for hContact
- wParam=(WPARAM)(HANDLE)hContact
- lParam=0
+ wParam = (WPARAM)(HANDLE)hContact
+ lParam = 0
Returns the handle, or NULL if hContact is invalid or has no events
Events in a chain are sorted chronologically automatically
*/
@@ -563,8 +563,8 @@ Events in a chain are sorted chronologically automatically /* DB/Event/FindFirstUnread
Retrieves a handle to the first unread event in the chain for hContact
- wParam=(WPARAM)(HANDLE)hContact
- lParam=0
+ wParam = (WPARAM)(HANDLE)hContact
+ lParam = 0
Returns the handle, or NULL if hContact is invalid or all its events have been
read
Events in a chain are sorted chronologically automatically, but this does not
@@ -577,8 +577,8 @@ unread from last time /* DB/Event/FindLast
Retrieves a handle to the last event in the chain for hContact
- wParam=(WPARAM)(HANDLE)hContact
- lParam=0
+ wParam = (WPARAM)(HANDLE)hContact
+ lParam = 0
Returns the handle, or NULL if hContact is invalid or has no events
Events in a chain are sorted chronologically automatically
*/
@@ -586,8 +586,8 @@ Events in a chain are sorted chronologically automatically /* DB/Event/FindNext
Retrieves a handle to the next event in a chain after hDbEvent
- wParam=(WPARAM)(HANDLE)hDbEvent
- lParam=0
+ wParam = (WPARAM)(HANDLE)hDbEvent
+ lParam = 0
Returns the handle, or NULL if hDbEvent is invalid or is the last event
Events in a chain are sorted chronologically automatically
*/
@@ -595,8 +595,8 @@ Events in a chain are sorted chronologically automatically /* DB/Event/FindPrev
Retrieves a handle to the previous event in a chain before hDbEvent
- wParam=(WPARAM)(HANDLE)hDbEvent
- lParam=0
+ wParam = (WPARAM)(HANDLE)hDbEvent
+ lParam = 0
Returns the handle, or NULL if hDbEvent is invalid or is the first event
Events in a chain are sorted chronologically automatically
*/
@@ -606,8 +606,8 @@ Events in a chain are sorted chronologically automatically /* DB/Crypt/EncodeString
Scrambles pszString in-place using a strange encryption algorithm
- wParam=(WPARAM)(int)cbString
- lParam=(LPARAM)(char*)pszString
+ wParam = (WPARAM)(int)cbString
+ lParam = (LPARAM)(char*)pszString
cbString is the size of the buffer pointed to by pszString, *not* the length
of pszString. This service may be changed at a later date such that it
increases the length of pszString
@@ -617,8 +617,8 @@ Returns 0 always /* DB/Crypt/DecodeString
Descrambles pszString in-place using the strange encryption algorithm
- wParam=(WPARAM)(int)cbString
- lParam=(LPARAM)(char*)pszString
+ wParam = (WPARAM)(int)cbString
+ lParam = (LPARAM)(char*)pszString
Reverses the operation done by crypt/encodestring
cbString is the size of the buffer pointed to by pszString, *not* the length
of pszString.
@@ -630,8 +630,8 @@ Returns 0 always /* DB/Time/TimestampToLocal
Converts a GMT timestamp into local time
- wParam=(WPARAM)(DWORD)timestamp
- lParam=0
+ wParam = (WPARAM)(DWORD)timestamp
+ lParam = 0
Returns the converted value
Timestamps have zero at midnight 1/1/1970 GMT, this service converts such a
value to be based at midnight 1/1/1970 local time.
@@ -648,8 +648,8 @@ disadvantages :-)). /* DB/Time/TimestampToString
Converts a GMT timestamp into a customisable local time string
- wParam=(WPARAM)(DWORD)timestamp
- lParam=(LPARAM)(DBTIMETOSTRING*)&tts
+ wParam = (WPARAM)(DWORD)timestamp
+ lParam = (LPARAM)(DBTIMETOSTRING*)&tts
Returns 0 always
Uses db/time/timestamptolocal for the conversion so read that description to
see what's going on.
@@ -682,8 +682,8 @@ typedef struct { /*
Switches safety settings on or off
-wParam=(WPARAM)(BOOL)newSetting
-lParam=0
+wParam = (WPARAM)(BOOL)newSetting
+lParam = 0
returns 0 always
newSetting is TRUE initially.
Miranda's database is normally protected against corruption by agressively
@@ -702,8 +702,8 @@ so you need not use this service for that purpose. /* db/modules/enum v0.1.0.1+
Enumerates the names of all modules that have stored or requested information
from the database.
-wParam=lParam
-lParam=(WPARAM)(DBMODULEENUMPROC)dbmep
+wParam = lParam
+lParam = (WPARAM)(DBMODULEENUMPROC)dbmep
Returns the value returned by the last call to dbmep
This service is only really useful for debugging, in conjunction with
db/contact/enumsettings
@@ -718,7 +718,7 @@ szModuleName is only guaranteed to be valid for the duration of the callback. If you want to keep it for longer you must allocation your own storage.
**BUG**: Prior to 0.1.2.0 dbmep was called as (lParam)(szMod, ofsMod, lParam).
This means that the lParam parameter to dbmep was useless, and explains the
- slightly odd 'wParam=lParam' in the definition.
+ slightly odd 'wParam = lParam' in the definition.
*/
typedef int (*DBMODULEENUMPROC)(const char *szModuleName, DWORD ofsModuleName, LPARAM lParam);
#define MS_DB_MODULES_ENUM "DB/Modules/Enum"
@@ -726,8 +726,8 @@ typedef int (*DBMODULEENUMPROC)(const char *szModuleName, DWORD ofsModuleName, L /* DB/Module/Delete 0.8.0+
Removes all settings for the specified module.
-wParam=0 (unused)
-lParam=(LPARAM)(char*)szModuleName - the module name to be deleted
+wParam = 0 (unused)
+lParam = (LPARAM)(char*)szModuleName - the module name to be deleted
*/
#define MS_DB_MODULE_DELETE "DB/Module/Delete"
@@ -738,8 +738,8 @@ lParam=(LPARAM)(char*)szModuleName - the module name to be deleted /* DB/Event/Added event
Called when a new event has been added to the event chain for a contact
- wParam=(WPARAM)(HANDLE)hContact
- lParam=(LPARAM)(HANDLE)hDbEvent
+ wParam = (WPARAM)(HANDLE)hContact
+ lParam = (LPARAM)(HANDLE)hDbEvent
hDbEvent is a valid handle to the event. hContact is a valid handle to the
contact to which hDbEvent refers.
Since events are sorted chronologically, you cannot guarantee that hDbEvent is
@@ -756,8 +756,8 @@ passed to MS_DB_EVENT_ADD. The point of this hook is to stop any unwanted database events, to stop
an event being added, return 1, to allow the event to pass through return
0.
- wParam=(WPARAM)(HANDLE)hContact
- lParam=(LPARAM)&DBEVENTINFO
+ wParam = (WPARAM)(HANDLE)hContact
+ lParam = (LPARAM)&DBEVENTINFO
Any changed made to the said DBEVENTINFO are also passed along to the database,
therefore it is possible to shape the data, however DO NOT DO THIS.
@@ -766,8 +766,8 @@ therefore it is possible to shape the data, however DO NOT DO THIS. /* DB/Event/Deleted event
Called when an event is about to be deleted from the event chain for a contact
- wParam=(WPARAM)(HANDLE)hContact
- lParam=(LPARAM)(HANDLE)hDbEvent
+ wParam = (WPARAM)(HANDLE)hContact
+ lParam = (LPARAM)(HANDLE)hDbEvent
hDbEvent is a valid handle to the event which is about to be deleted, but it
won't be once your hook has returned.
hContact is a valid handle to the contact to which hDbEvent refers, and will
@@ -779,8 +779,8 @@ usual, stop other hooks from being called. /* DB/Contact/Added event
Called when a new contact has been added to the database
- wParam=(WPARAM)(HANDLE)hContact
- lParam=0
+ wParam = (WPARAM)(HANDLE)hContact
+ lParam = 0
hContact is a valid handle to the new contact.
Contacts are initially created without any settings, so if you hook this event
you will almost certainly also want to hook db/contact/settingchanged as well.
@@ -789,8 +789,8 @@ you will almost certainly also want to hook db/contact/settingchanged as well. /* DB/Contact/Deleted event
Called when an contact is about to be deleted
- wParam=(WPARAM)(HANDLE)hContact
- lParam=0
+ wParam = (WPARAM)(HANDLE)hContact
+ lParam = 0
hContact is a valid handle to the contact which is about to be deleted, but it
won't be once your hook has returned.
Returning nonzero from your hook will not stop the deletion, but it will, as
@@ -801,8 +801,8 @@ Deleting a contact invalidates all events in its chain. /* DB/Contact/SettingChanged event
Called when a contact has had one of its settings changed
- wParam=(WPARAM)(HANDLE)hContact
- lParam=(LPARAM)(DBCONTACTWRITESETTING*)&dbcws
+ wParam = (WPARAM)(HANDLE)hContact
+ lParam = (LPARAM)(DBCONTACTWRITESETTING*)&dbcws
hContact is a valid handle to the contact that has changed.
This event will be triggered many times rapidly when a whole bunch of values
are set.
@@ -816,8 +816,8 @@ don't change any of the members. /* DB/Contact/SetSettingResident service (0.6+)
Disables a setting saving to the database.
- wParam=(WPARAM)(BOOL)bIsResident
- lParam=(LPARAM)(char*)pszSettingName
+ wParam = (WPARAM)(BOOL)bIsResident
+ lParam = (LPARAM)(char*)pszSettingName
*/
#define MS_DB_SETSETTINGRESIDENT "DB/SetSettingResident"
diff --git a/include/m_email.h b/include/m_email.h index 5ff1962328..c19979ed5e 100644 --- a/include/m_email.h +++ b/include/m_email.h @@ -25,8 +25,8 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #define M_EMAIL_H__ 1
//send an e-mail to the specified contact v0.1.0.1+
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=0
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = 0
//returns 0 on success or nonzero on failure
//if an error occurs the service will display a message box with the error
//text, so this service should not be used if you do not want this behaviour.
diff --git a/include/m_file.h b/include/m_file.h index 44c9ff1c27..7285078a64 100644 --- a/include/m_file.h +++ b/include/m_file.h @@ -25,16 +25,16 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #define M_FILE_H__ 1
//brings up the send file dialog for a contact
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=0
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = 0
//returns 0 on success or nonzero on failure
//returns immediately, without waiting for the send
#define MS_FILE_SENDFILE "SRFile/SendCommand"
//brings up the send file dialog with the specified files already chosen
//v0.1.2.1+
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=(LPARAM)(const char**)ppFiles
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = (LPARAM)(const char**)ppFiles
//returns 0 on success or nonzero on failure
//returns immediately, without waiting for the send
//the user is not prevented from changing the filename with the 'choose again'
@@ -48,15 +48,15 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #define MS_FILE_SENDSPECIFICFILES "SRFile/SendSpecificFiles"
//v0.9.0+
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=(LPARAM)(const TCHAR**)ppFiles
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = (LPARAM)(const TCHAR**)ppFiles
//returns 0 on success or nonzero on failure
//returns immediately, without waiting for the send
#define MS_FILE_SENDSPECIFICFILEST "SRFile/SendSpecificFilesT"
//get the received files folder v0.1.2.2+
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=(LPARAM)(char *)pszOutput
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = (LPARAM)(char *)pszOutput
//returns 0 on success or nonzero on failure
//pszOutput must be at least MAX_PATH characters long
//If hContact is NULL this function will retrieve the received files folder
diff --git a/include/m_findadd.h b/include/m_findadd.h index ed0cd60ec8..9e7d170595 100644 --- a/include/m_findadd.h +++ b/include/m_findadd.h @@ -26,7 +26,7 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. /* Opens the find/add users dialog box, or gives it the focus if it's already
open.
-wParam=lParam=0
+wParam = lParam = 0
returns 0 always
*/
#define MS_FINDADD_FINDADD "FindAdd/FindAddCommand"
diff --git a/include/m_fuse.h b/include/m_fuse.h index 7df4d1e89b..1c00720851 100644 --- a/include/m_fuse.h +++ b/include/m_fuse.h @@ -7,9 +7,9 @@ typedef int (*MIRANDAHOOK)(WPARAM, LPARAM);
typedef INT_PTR (*MIRANDASERVICE)(WPARAM, LPARAM);
-#define FUSE_INIT 0 // core started, Param=**FUSE_LINK
+#define FUSE_INIT 0 // core started, Param = **FUSE_LINK
#define FUSE_DEINIT 1 // core stopped
-#define FUSE_DEFMOD 3 // LoadDefaultModules() return code, Param=*int
+#define FUSE_DEFMOD 3 // LoadDefaultModules() return code, Param = *int
#define FUSE_DEATH 4 // DestroyingModularEngine() just got called
typedef struct {
diff --git a/include/m_history.h b/include/m_history.h index cf6b85cf70..dba50b83bc 100644 --- a/include/m_history.h +++ b/include/m_history.h @@ -25,8 +25,8 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #define M_HISTORY_H__ 1
//show the History dialog box for a contact
-// wParam=(WPARAM)(HANDLE)hContact
-// lParam=0
+// wParam = (WPARAM)(HANDLE)hContact
+// lParam = 0
//hContact can be NULL to show system messages
#define MS_HISTORY_SHOWCONTACTHISTORY "History/ShowContactHistory"
diff --git a/include/m_hotkeys.h b/include/m_hotkeys.h index 7d6acba08f..7bd596b3ed 100644 --- a/include/m_hotkeys.h +++ b/include/m_hotkeys.h @@ -63,8 +63,8 @@ extern int hLangpack; /* CoreHotkeys/Register service
Registers new hotkey
- wParam=(WPARAM)0
- lParam=(LPARAM)(HOTKEYDESC *)hotkey
+ wParam = (WPARAM)0
+ lParam = (LPARAM)(HOTKEYDESC *)hotkey
Returns 0 on failure or hotkey atom id on success
*/
@@ -75,23 +75,23 @@ __inline static INT_PTR Hotkey_Register(HOTKEYDESC *hk) /* CoreHotkeys/Unregister service
Unregister existing hotkey
- wParam=(WPARAM)0
- lParam=(LPARAM)(char *)pszName
+ wParam = (WPARAM)0
+ lParam = (LPARAM)(char *)pszName
Returns 0 on success or nonzero otherwise
*/
#define MS_HOTKEY_UNREGISTER "CoreHotkeys/Unregister"
/* CoreHotkeys/Check service
Checks if "manual" hotkey was activated and returns its id.
- wParam=(WPARAM)(MSG *)message
- lParam=(LPARAM)(char *)pszSection
+ wParam = (WPARAM)(MSG *)message
+ lParam = (LPARAM)(char *)pszSection
Returns lParam associated with activated hotkey
*/
#define MS_HOTKEY_CHECK "CoreHotkeys/Check"
/* Subclass/unsubclass edit box to act as hotkey control
- wParam=(WPARAM)(HWND)hwndEdit
- lParam=(LPARAM)0
+ wParam = (WPARAM)(HWND)hwndEdit
+ lParam = (LPARAM)0
Returns zero on success
You will get notification with LOWORD(wParam) == 0 when users sets hotkey.
diff --git a/include/m_icq.h b/include/m_icq.h index eb585715c3..18b00fe5eb 100644 --- a/include/m_icq.h +++ b/include/m_icq.h @@ -46,38 +46,38 @@ typedef struct { // Request authorization
-// wParam=(WPARAM)hContact
+// wParam = (WPARAM)hContact
#define MS_REQ_AUTH "/ReqAuth"
// Grant authorization
-// wParam=(WPARAM)hContact;
+// wParam = (WPARAM)hContact;
#define MS_GRANT_AUTH "/GrantAuth"
// Revoke authorization
-// wParam=(WPARAM)hContact
+// wParam = (WPARAM)hContact
#define MS_REVOKE_AUTH "/RevokeAuth"
// Open ICQ profile
-// wParam=(WPARAM)hContact
+// wParam = (WPARAM)hContact
#define MS_OPEN_PROFILE "/OpenProfile"
// Add contact to server-list
-// wParam=(WPARAM)hContact
+// wParam = (WPARAM)hContact
#define MS_ICQ_ADDSERVCONTACT "/AddServerContact"
// Display XStatus detail (internal use only)
-// wParam=(WPARAM)hContact;
+// wParam = (WPARAM)hContact;
#define MS_XSTATUS_SHOWDETAILS "/ShowXStatusDetails"
//Send an SMS via the ICQ network
-//wParam=(WPARAM)(const char*)szPhoneNumber
-//lParam=(LPARAM)(const char*)szMessage
+//wParam = (WPARAM)(const char*)szPhoneNumber
+//lParam = (LPARAM)(const char*)szMessage
//Returns a HANDLE to the send on success, or NULL on failure
//szPhoneNumber should be the full number with international code and preceeded
//by a +
//When the server acks the send, an ack will be broadcast:
-// type=ICQACKTYPE_SMS, result=ACKRESULT_SENTREQUEST, lParam=(LPARAM)(char*)szInfo
+// type = ICQACKTYPE_SMS, result = ACKRESULT_SENTREQUEST, lParam = (LPARAM)(char*)szInfo
//At this point the message is queued to be delivered. szInfo contains the raw
//XML data of the ack. Here's what I got when I tried:
//"<sms_response><source>airbornww.com</source><deliverable>Yes</deliverable><network>BT Cellnet, United Kingdom</network><message_id>[my uin]-1-1955988055-[destination phone#, without +]</message_id><messages_left>0</messages_left></sms_response>\r\n"
@@ -87,7 +87,7 @@ typedef struct { //At a (possibly much) later time the SMS will have been delivered. An ack will
//be broadcast:
-// type=ICQACKTYPE_SMS, result=ACKRESULT_SUCCESS, hProcess=NULL, lParam=(LPARAM)(char*)szInfo
+// type = ICQACKTYPE_SMS, result = ACKRESULT_SUCCESS, hProcess = NULL, lParam = (LPARAM)(char*)szInfo
//Note that the result will always be success even if the send failed, just to
//save needing to have an attempt at an XML parser in the ICQ module.
//Here's the szInfo for a success:
@@ -126,23 +126,23 @@ typedef struct { //for server-side lists, used internally only
-//hProcess=dwSequence
-//lParam=server's error code, 0 for success
+//hProcess = dwSequence
+//lParam = server's error code, 0 for success
#define ICQACKTYPE_SERVERCLIST 1003
//for rate warning distribution (mainly upload dlg)
-//hProcess=Rate class ID
-//lParam=server's status code
+//hProcess = Rate class ID
+//lParam = server's status code
#define ICQACKTYPE_RATEWARNING 1004
//received Xtraz Notify response
-//hProcess=dwSequence
-//lParam=contents of RES node
+//hProcess = dwSequence
+//lParam = contents of RES node
#define ICQACKTYPE_XTRAZNOTIFY_RESPONSE 1005
//received Custom Status details response
-//hProcess=dwSequence
-//lParam=0
+//hProcess = dwSequence
+//lParam = 0
#define ICQACKTYPE_XSTATUS_RESPONSE 1006
@@ -158,21 +158,21 @@ typedef struct { #define CIXT_EXTRA 0x0080
#define CIXT_FULL 0x00FF
-//wParam=operationType
+//wParam = operationType
#define PS_CHANGEINFOEX "/ChangeInfoEx"
//Change nickname in White pages
-//lParam=(LPARAM)(const char*)szNewNickName
+//lParam = (LPARAM)(const char*)szNewNickName
#define PS_SET_NICKNAME "/SetNickname"
//Set password for current session
-//lParam=(LPARAM)(const char*)szPassword
+//lParam = (LPARAM)(const char*)szPassword
#define PS_ICQ_SETPASSWORD "/SetPassword"
//miranda/icqoscar/statusmsgreq event
//called when our status message is requested
-//wParam=(BYTE)msgType
-//lParam=(DWORD)uin
+//wParam = (BYTE)msgType
+//lParam = (DWORD)uin
//msgType is one of the ICQ_MSGTYPE_GET###MSG constants in icq_constants.h
//uin is the UIN of the contact requesting our status message
#define ME_ICQ_STATUSMSGREQ "/StatusMsgReq"
diff --git a/include/m_ignore.h b/include/m_ignore.h index 9dd861bf3e..c20a029502 100644 --- a/include/m_ignore.h +++ b/include/m_ignore.h @@ -37,26 +37,26 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #define IGNOREEVENT_TYPINGNOTIFY 7 // 0.7+
//determines if a message type to a contact should be ignored v0.1.0.1+
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=message type, an ignoreevent_ constant
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = message type, an ignoreevent_ constant
//returns 0 if the message should be shown, or nonzero if it should be ignored
-//Use hContact=NULL to retrieve the setting for unknown contacts (not on the
+//Use hContact = NULL to retrieve the setting for unknown contacts (not on the
//contact list, as either permanent or temporary).
//don't use ignoreevent_all when calling this service
#define MS_IGNORE_ISIGNORED "Ignore/IsIgnored"
//ignore future messages from a contact v0.1.0.1+
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=message type, an ignoreevent_ constant
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = message type, an ignoreevent_ constant
//returns 0 on success or nonzero on failure
-//Use hContact=NULL to retrieve the setting for unknown contacts
+//Use hContact = NULL to retrieve the setting for unknown contacts
#define MS_IGNORE_IGNORE "Ignore/Ignore"
//receive future messages from a contact v0.1.0.1+
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=message type, an ignoreevent_ constant
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = message type, an ignoreevent_ constant
//returns 0 on success or nonzero on failure
-//Use hContact=NULL to retrieve the setting for unknown contacts
+//Use hContact = NULL to retrieve the setting for unknown contacts
#define MS_IGNORE_UNIGNORE "Ignore/Unignore"
diff --git a/include/m_json.h b/include/m_json.h index 2326728302..38c3a5e44e 100644 --- a/include/m_json.h +++ b/include/m_json.h @@ -1,43 +1,43 @@ -/*
-
-Miranda IM: the free IM client for Microsoft* Windows*
-
-Copyright 2000-2008 Miranda ICQ/IM project,
-all portions of this codebase are copyrighted to the people
-listed in contributors.txt.
-
-This program is free software; you can redistribute it and/or
-modify it under the terms of the GNU General Public License
-as published by the Free Software Foundation; either version 2
-of the License, or (at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
-*/
-
-#ifndef MIM_LIBJSON_H
-#define MIM_LIBJSON_H
-
-#define IsJSONServiceAvailable() (ServiceExists(MS_JSON_FREE))
-#define json_getJSI(a) CallService(MS_JSON_GETINTERFACE,(WPARAM)a,0)
-
-#ifndef LIBJSON_H
+/* + +Miranda IM: the free IM client for Microsoft* Windows* + +Copyright 2000-2008 Miranda ICQ/IM project, +all portions of this codebase are copyrighted to the people +listed in contributors.txt. + +This program is free software; you can redistribute it and/or +modify it under the terms of the GNU General Public License +as published by the Free Software Foundation; either version 2 +of the License, or (at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. +*/ + +#ifndef MIM_LIBJSON_H +#define MIM_LIBJSON_H + +#define IsJSONServiceAvailable() (ServiceExists(MS_JSON_FREE)) +#define json_getJSI(a) CallService(MS_JSON_GETINTERFACE,(WPARAM)a,0) + +#ifndef LIBJSON_H #define JSONNODE void //so that JSONNODE* is void* typedef JSONNODE** JSONNODE_ITERATOR; -#endif
-
-// This function get the service interface for direct calling
-// wParam=(WPARAM)(LPJSONSERVICEINTERFACE)
-// lParam=0
-// Return value ALWAYS 0
-
-typedef struct {
+#endif + +// This function get the service interface for direct calling +// wParam = (WPARAM)(LPJSONSERVICEINTERFACE) +// lParam = 0 +// Return value ALWAYS 0 + +typedef struct { /* stuff that's in namespace libJSON */ @@ -139,13 +139,13 @@ typedef struct { //comparison int (*equal)(JSONNODE * node, JSONNODE * node2); -} JSONSERVICEINTERFACE, *PJSONSERVICEINTERFACE, *LPJSONSERVICEINTERFACE;
-
-
-#ifndef _STATIC
-extern JSONSERVICEINTERFACE jsi;
-
-#ifndef LIBJSON_H
+} JSONSERVICEINTERFACE, *PJSONSERVICEINTERFACE, *LPJSONSERVICEINTERFACE; + + +#ifndef _STATIC +extern JSONSERVICEINTERFACE jsi; + +#ifndef LIBJSON_H #define json_free(a) jsi.free(a) #define json_delete(a) jsi.delete_(a) // #ifdef JSON_MEMORY_MANAGE @@ -226,9 +226,9 @@ extern JSONSERVICEINTERFACE jsi; #define json_begin(a) jsi.begin(a) #define json_end(a) jsi.end(a) #define json_equal(a,b) jsi.equal(a,b) -#endif
-#endif // _STATIC
-
-#define MS_JSON_GETINTERFACE "JSON/GetInterface"
-
-#endif // MIM_LIBJSON_H
+#endif +#endif // _STATIC + +#define MS_JSON_GETINTERFACE "JSON/GetInterface" + +#endif // MIM_LIBJSON_H diff --git a/include/m_langpack.h b/include/m_langpack.h index efcca8d27c..61d8bcc78f 100644 --- a/include/m_langpack.h +++ b/include/m_langpack.h @@ -33,8 +33,8 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #endif
//translates a single string into the user's local language v0.1.1.0+
-//wParam=0
-//lParam=(LPARAM)(const char*)szEnglish
+//wParam = 0
+//lParam = (LPARAM)(const char*)szEnglish
//returns a pointer to the localised string. If there is no known translation
//it will return szEnglish. The return value does not need to be freed in any
//way
@@ -57,26 +57,26 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. //Those macros do NOTHING. They are just markers for lpgen.pl.
//translates a menu into the user's local language v0.1.1.0+
-//wParam=(WPARAM)(HMENU)hMenu
-//lParam=langpack handle (v.0.10.0+)
+//wParam = (WPARAM)(HMENU)hMenu
+//lParam = langpack handle (v.0.10.0+)
//returns 0 on success, nonzero on failure
#define MS_LANGPACK_TRANSLATEMENU "LangPack/TranslateMenu"
//returns the codepage used in the language pack v0.4.3.0+
-//wParam=0
-//lParam=0
+//wParam = 0
+//lParam = 0
//returns the codepage stated in the langpack, or CP_ACP if no langpack is present
#define MS_LANGPACK_GETCODEPAGE "LangPack/GetCodePage"
//returns the locale id associated with the language pack v0.4.3.0+
-//wParam=0
-//lParam=0
+//wParam = 0
+//lParam = 0
//returns the Windows locale id stated in the langpack, or LOCALE_USER_DEFAULT if no langpack is present
#define MS_LANGPACK_GETLOCALE "LangPack/GetLocale"
//returns the strdup/wcsdup of lparam according to the langpack v0.4.3.0+
-//wParam=langpack handle (v.0.10.0+)
-//lParam=(LPARAM)(char*)source string
+//wParam = langpack handle (v.0.10.0+)
+//lParam = (LPARAM)(char*)source string
//returns a string converted from char* to TCHAR* using the langpack codepage.
//This string should be freed using mir_free() then
#define MS_LANGPACK_PCHARTOTCHAR "LangPack/PcharToTchar"
@@ -96,8 +96,8 @@ __inline static INT_PTR Langpack_PCharToTChar(const char* str) #endif
//initializes the plugin-specific translation context v0.10.0+
-//wParam=pointer to the langpack handle
-//lParam=PLUGININFOEX* of the caller plugin
+//wParam = pointer to the langpack handle
+//lParam = PLUGININFOEX* of the caller plugin
//always returns 0
#define MS_LANGPACK_REGISTER "LangPack/Register"
@@ -108,8 +108,8 @@ __inline static void mir_getLP(const PLUGININFOEX* pInfo) #endif
//reloads langpack
-//wParam=0 (ignored)
-//lParam=(LPARAM)(TCHAR*)langpack file name or NULL to reload the current one
+//wParam = 0 (ignored)
+//lParam = (LPARAM)(TCHAR*)langpack file name or NULL to reload the current one
//always returns 0
#define MS_LANGPACK_RELOAD "LangPack/Reload"
diff --git a/include/m_message.h b/include/m_message.h index 4c503704ea..c5a8a484ec 100644 --- a/include/m_message.h +++ b/include/m_message.h @@ -25,12 +25,12 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #define M_MESSAGE_H__ 1
//brings up the send message dialog for a contact
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=(LPARAM)(char*)szText
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = (LPARAM)(char*)szText
//returns 0 on success or nonzero on failure
//returns immediately, just after the dialog is shown
//szText is the text to put in the edit box of the window (but not send)
-//szText=NULL will not use any text
+//szText = NULL will not use any text
//szText != NULL is only supported on v0.1.2.0+
#define MS_MSG_SENDMESSAGE "SRMsg/SendCommand"
#define MS_MSG_SENDMESSAGEW "SRMsg/SendCommandW"
@@ -42,8 +42,8 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #endif
#define ME_MSG_WINDOWEVENT "MessageAPI/WindowEvent"
-//wparam=0
-//lparam=(WPARAM)(MessageWindowEventData*)hWindowEvent;
+//wparam = 0
+//lparam = (WPARAM)(MessageWindowEventData*)hWindowEvent;
//Event types
#define MSG_WINDOW_EVT_OPENING 1 //window is about to be opened
#define MSG_WINDOW_EVT_OPEN 2 //window has been opened
@@ -68,14 +68,14 @@ typedef struct { } MessageWindowEventData;
#define MS_MSG_GETWINDOWAPI "MessageAPI/WindowAPI"
-//wparam=0
-//lparam=0
+//wparam = 0
+//lparam = 0
//Returns a dword with the current message api version
//Current version is 0, 0, 0, 4
#define MS_MSG_GETWINDOWCLASS "MessageAPI/WindowClass"
-//wparam=(char*)szBuf
-//lparam=(int)cbSize size of buffer
+//wparam = (char*)szBuf
+//lparam = (int)cbSize size of buffer
//Sets the window class name in wParam (ex. "SRMM" for srmm.dll)
typedef struct {
@@ -99,8 +99,8 @@ typedef struct { } MessageWindowData;
#define MS_MSG_GETWINDOWDATA "MessageAPI/GetWindowData"
-//wparam=(MessageWindowInputData*)
-//lparam=(MessageWindowData*)
+//wparam = (MessageWindowInputData*)
+//lparam = (MessageWindowData*)
//returns 0 on success and returns non-zero (1) on error or if no window data exists for that hcontact
diff --git a/include/m_netlib.h b/include/m_netlib.h index 20db435de5..fb0d13f27b 100644 --- a/include/m_netlib.h +++ b/include/m_netlib.h @@ -43,8 +43,8 @@ struct NETLIBOPENCONNECTION_tag; typedef struct NETLIBOPENCONNECTION_tag NETLIBOPENCONNECTION;
//Initialises the netlib for a set of connections
-//wParam=0
-//lParam=(LPARAM)(NETLIBUSER*)&nu
+//wParam = 0
+//lParam = (LPARAM)(NETLIBUSER*)&nu
//Returns a HANDLE to be used for future netlib calls, NULL on failure
//NOTE: Netlib is loaded after any plugins, so you need to wait until
// ME_SYSTEM_MODULESLOADED before calling this function
@@ -95,14 +95,14 @@ typedef struct { //Assign a Netlib user handle a set of dynamic HTTP headers to be used with all
//
//HTTP connections that enable the HTTP-use-sticky headers flag.
-//The headers persist until cleared with lParam=NULL.
+//The headers persist until cleared with lParam = NULL.
//
//All memory should be allocated by the caller using malloc() from MS_SYSTEM_GET_MMI
//Once it has passed to Netlib, Netlib is the owner of it, the caller should not refer to the memory
//In any way after this point.
//
-//wParam=(WPARAM)hNetLibUser
-//lParam=(LPARAM)(char*)szHeaders
+//wParam = (WPARAM)hNetLibUser
+//lParam = (LPARAM)(char*)szHeaders
//
//NOTE: The szHeaders parameter should be a NULL terminated string following the HTTP header syntax.
//This string will be injected verbatim, thus the user should be aware of setting strings that are not
@@ -172,8 +172,8 @@ should use the MSG_DUMPPROXY flag so that the logging is neat. */
//Gets the user-configured settings for a netlib user
-//wParam=(WPARAM)(HANDLE)hUser
-//lParam=(LPARAM)(NETLIBUSERSETTINGS*)&nlus
+//wParam = (WPARAM)(HANDLE)hUser
+//lParam = (LPARAM)(NETLIBUSERSETTINGS*)&nlus
//Returns nonzero on success, 0 on failure ( !! this is different to most of the rest of Miranda, but consistent with netlib)
//The pointers referred to in the returned struct will remain valid until
//the hUser handle is closed, or until the user changes the settings in the
@@ -205,8 +205,8 @@ typedef struct { #define MS_NETLIB_GETUSERSETTINGS "Netlib/GetUserSettings"
//Changes the user-configurable settings for a netlib user
-//wParam=(WPARAM)(HANDLE)hUser
-//lParam=(LPARAM)(NETLIBUSERSETTINGS*)&nlus
+//wParam = (WPARAM)(HANDLE)hUser
+//lParam = (LPARAM)(NETLIBUSERSETTINGS*)&nlus
//Returns nonzero on success, 0 on failure ( !! this is different to most of the rest of Miranda, but consistent with netlib)
//This function is only really useful for people that specify NUF_NOOPTIONS
//and want to create their own options.
@@ -216,8 +216,8 @@ typedef struct { #define MS_NETLIB_SETUSERSETTINGS "Netlib/SetUserSettings"
//Closes a netlib handle
-//wParam=(WPARAM)(HANDLE)hNetlibHandle
-//lParam=0
+//wParam = (WPARAM)(HANDLE)hNetlibHandle
+//lParam = 0
//Returns nonzero on success, 0 on failure ( !! this is different to most of the rest of Miranda, but consistent with netlib)
//This function should be called on all handles returned by netlib functions
//once you are done with them. If it's called on a socket-type handle, the
@@ -227,8 +227,8 @@ typedef struct { __inline static INT_PTR Netlib_CloseHandle(HANDLE h) {return CallService(MS_NETLIB_CLOSEHANDLE, (WPARAM)h, 0);}
//Open a port and wait for connections on it
-//wParam=(WPARAM)(HANDLE)hUser
-//lParam=(LPARAM)(NETLIBBIND*)&nlb
+//wParam = (WPARAM)(HANDLE)hUser
+//lParam = (LPARAM)(NETLIBBIND*)&nlb
//Returns a HANDLE on success, NULL on failure
//hUser should have been returned by MS_NETLIB_REGISTERUSER
//This function does the equivalent of socket(), bind(), getsockname(),
@@ -294,8 +294,8 @@ typedef struct { #define MS_NETLIB_BINDPORT "Netlib/BindPort"
//Open a connection
-//wParam=(WPARAM)(HANDLE)hUser
-//lParam=(LPARAM)(NETLIBOPENCONNECTION*)&nloc
+//wParam = (WPARAM)(HANDLE)hUser
+//lParam = (LPARAM)(NETLIBOPENCONNECTION*)&nloc
//Returns a HANDLE to the new connection on success, NULL on failure
//hUser must have been returned by MS_NETLIB_REGISTERUSER
//Internally this function is the equivalent of socket(), gethostbyname(),
@@ -349,8 +349,8 @@ struct NETLIBOPENCONNECTION_tag { #define MS_NETLIB_OPENCONNECTION "Netlib/OpenConnection"
//Sets the required information for an HTTP proxy connection
-//wParam=(WPARAM)(HANDLE)hConnection
-//lParam=(LPARAM)(NETLIBHTTPPROXYINFO*)&nlhpi
+//wParam = (WPARAM)(HANDLE)hConnection
+//lParam = (LPARAM)(NETLIBHTTPPROXYINFO*)&nlhpi
//Returns nonzero on success, 0 on failure ( !! this is different to most of the rest of Miranda, but consistent with netlib)
//This function is designed to be called from within pfnHttpGatewayInit
//See notes below MS_NETLIB_REGISTERUSER.
@@ -370,8 +370,8 @@ typedef struct { #define MS_NETLIB_SETHTTPPROXYINFO "Netlib/SetHttpProxyInfo"
//Gets the SOCKET associated with a netlib handle
-//wParam=(WPARAM)(HANDLE)hNetlibHandle
-//lParam=0
+//wParam = (WPARAM)(HANDLE)hNetlibHandle
+//lParam = 0
//Returns the SOCKET on success, INVALID_SOCKET on failure
//hNetlibHandle should have been returned by MS_NETLIB_BINDPORT or
//MS_NETLIB_OPENCONNECTION only.
@@ -381,8 +381,8 @@ typedef struct { #define MS_NETLIB_GETSOCKET "Netlib/GetSocket"
//URL-encode a string for x-www-form-urlencoded (and other) transmission
-//wParam=0
-//lParam=(LPARAM)(const char *)pszString
+//wParam = 0
+//lParam = (LPARAM)(const char *)pszString
//Returns a char* containing the new string. This must be freed with
//HeapFree(GetProcessHeap(), 0, pszReturnString) when you're done with it.
//Returns NULL on error.
@@ -390,8 +390,8 @@ typedef struct { #define MS_NETLIB_URLENCODE "Netlib/UrlEncode"
//Base64 decode a string. See rfc1421.
-//wParam=0
-//lParam=(LPARAM)(NETLIBBASE64*)&nlb64
+//wParam = 0
+//lParam = (LPARAM)(NETLIBBASE64*)&nlb64
//Returns nonzero on success, 0 on failure ( !! this is different to most of the rest of Miranda, but consistent with netlib)
//nlb64.pszEncoded and nlb64.cchEncoded contain the input string and its length
//(excluding terminating zero).
@@ -410,8 +410,8 @@ typedef struct { #define MS_NETLIB_BASE64DECODE "Netlib/Base64Decode"
//Base64 encode a string. See rfc1421.
-//wParam=0
-//lParam=(LPARAM)(NETLIBBASE64*)&nlb64
+//wParam = 0
+//lParam = (LPARAM)(NETLIBBASE64*)&nlb64
//Returns nonzero on success, 0 on failure ( !! this is different to most of the rest of Miranda, but consistent with netlib)
//nlb64.pbDecoded and nlb64.cbDecoded contain the input buffer and its length
//nlb64.pszEncoded and nlb64.cchEncoded contain the buffer in which to put the
@@ -427,16 +427,16 @@ typedef struct { // Converts string representation of IP and port into numerical SOCKADDR_INET
// IPv4 could supplied in formats address:port or address
// IPv6 could supplied in formats [address]:port or [address]
-// wParam=(WPARAM)(char*) string to convert
-// lParam=(LPARAM)(SOCKADDR_INET*) numeric IP address structure
+// wParam = (WPARAM)(char*) string to convert
+// lParam = (LPARAM)(SOCKADDR_INET*) numeric IP address structure
// Returns 0 on success
#define MS_NETLIB_STARINGTOADDRESS "Netlib/StringToAddress"
// Converts numerical representation of IP in SOCKADDR_INET into string representation with IP and port
// IPv4 will be supplied in formats address:port or address
// IPv6 will be supplied in formats [address]:port or [address]
-// wParam=(WPARAM)(int) 0 - lParam - (sockaddr_gen*); 1 - lParam - (unsigned) in host byte order
-// lParam=(LPARAM)(sockaddr_gen*) or (unsigned) numeric IP address structure
+// wParam = (WPARAM)(int) 0 - lParam - (sockaddr_gen*); 1 - lParam - (unsigned) in host byte order
+// lParam = (LPARAM)(sockaddr_gen*) or (unsigned) numeric IP address structure
// Returns pointer to the string or NULL if not successful
#define MS_NETLIB_ADDRESSTOSTRING "Netlib/AddressToString"
@@ -450,8 +450,8 @@ typedef struct { // Get connection Information
// IPv4 will be supplied in formats address:port or address
// IPv6 will be supplied in formats [address]:port or [address]
-// wParam=(WPARAM)(HANDLE)hConnection
-// lParam=(LPARAM)(NETLIBCONNINFO*) pointer to the connection information structure to fill
+// wParam = (WPARAM)(HANDLE)hConnection
+// lParam = (LPARAM)(NETLIBCONNINFO*) pointer to the connection information structure to fill
// Returns 0 if successful
#define MS_NETLIB_GETCONNECTIONINFO "Netlib/GetConnectionInfo"
@@ -461,14 +461,14 @@ typedef struct { } NETLIBIPLIST;
// Get connection Information
-// wParam=(WPARAM)IP filter 1 - return global only IPv6 address, 0 all IPs
+// wParam = (WPARAM)IP filter 1 - return global only IPv6 address, 0 all IPs
// Returns (INT_PTR)(NETLIBIPLIST*) numeric IP address address array
// the last element of the array is all 0s, 0 if not successful
#define MS_NETLIB_GETMYIP "Netlib/GetMyIP"
//Send an HTTP request over a connection
-//wParam=(WPARAM)(HANDLE)hConnection
-//lParam=(LPARAM)(NETLIBHTTPREQUEST*)&nlhr
+//wParam = (WPARAM)(HANDLE)hConnection
+//lParam = (LPARAM)(NETLIBHTTPREQUEST*)&nlhr
//Returns number of bytes sent on success, SOCKET_ERROR on failure
//hConnection must have been returned by MS_NETLIB_OPENCONNECTION
//Note that if you use NLHRF_SMARTAUTHHEADER and NTLM authentication is in use
@@ -525,13 +525,13 @@ struct NETLIBHTTPREQUEST_tag { #define MS_NETLIB_SENDHTTPREQUEST "Netlib/SendHttpRequest"
//Receive HTTP headers
-//wParam=(WPARAM)(HANDLE)hConnection
-//lParam=0
+//wParam = (WPARAM)(HANDLE)hConnection
+//lParam = 0
//Returns a pointer to a NETLIBHTTPREQUEST structure on success, NULL on
//failure.
//Call MS_NETLIB_FREEHTTPREQUESTSTRUCT to free this.
//hConnection must have been returned by MS_NETLIB_OPENCONNECTION
-//nlhr->pData=NULL and nlhr->dataLength=0 always. The requested data should
+//nlhr->pData = NULL and nlhr->dataLength = 0 always. The requested data should
//be retrieved using MS_NETLIB_RECV once the header has been parsed.
//If the headers haven't finished within 60 seconds the function returns NULL
//and ERROR_TIMEOUT.
@@ -544,8 +544,8 @@ struct NETLIBHTTPREQUEST_tag { #define MS_NETLIB_RECVHTTPHEADERS "Netlib/RecvHttpHeaders"
//Free the memory used by a NETLIBHTTPREQUEST structure
-//wParam=0
-//lParam=(LPARAM)(NETLIBHTTPREQUEST*)pnlhr
+//wParam = 0
+//lParam = (LPARAM)(NETLIBHTTPREQUEST*)pnlhr
//Returns nonzero on success, 0 on failure ( !! this is different to most of the rest of Miranda, but consistent with netlib)
//This should only be called on structures returned by
//MS_NETLIB_RECVHTTPHEADERS or MS_NETLIB_HTTPTRANSACTION. Calling it on an
@@ -554,8 +554,8 @@ struct NETLIBHTTPREQUEST_tag { #define MS_NETLIB_FREEHTTPREQUESTSTRUCT "Netlib/FreeHttpRequestStruct"
//Do an entire HTTP transaction
-//wParam=(WPARAM)(HANDLE)hUser
-//lParam=(LPARAM)(NETLIBHTTPREQUEST*)&nlhr
+//wParam = (WPARAM)(HANDLE)hUser
+//lParam = (LPARAM)(NETLIBHTTPREQUEST*)&nlhr
//Returns a pointer to another NETLIBHTTPREQUEST structure on success, NULL on
//failure.
//Call MS_NETLIB_FREEHTTPREQUESTSTRUCT to free this.
@@ -572,7 +572,7 @@ struct NETLIBHTTPREQUEST_tag { // "User-Agent" (of the form "Miranda/0.1.2.2 (alpha)" or "Miranda/0.1.2.2")
// "Content-Length" (for POSTs only. Set to nlhr.dataLength)
//If you do not want to send one of these headers, create a nlhr.headers with
-//szValue=NULL.
+//szValue = NULL.
//In the return value headers, headerCount, pData, dataLength, resultCode and
//szResultDescr are all valid.
//In the return value pData[dataLength] == 0 always, as an extra safeguard
@@ -584,8 +584,8 @@ struct NETLIBHTTPREQUEST_tag { #define MS_NETLIB_HTTPTRANSACTION "Netlib/HttpTransaction"
//Send data over a connection
-//wParam=(WPARAM)(HANDLE)hConnection
-//lParam=(LPARAM)(NETLIBBUFFER*)&nlb
+//wParam = (WPARAM)(HANDLE)hConnection
+//lParam = (LPARAM)(NETLIBBUFFER*)&nlb
//Returns the number of bytes sent on success, SOCKET_ERROR on failure
//Errors: ERROR_INVALID_PARAMETER
// anything from send(), nlu.pfnHttpGatewayWrapSend()
@@ -606,13 +606,13 @@ typedef struct { } NETLIBBUFFER;
#define MS_NETLIB_SEND "Netlib/Send"
static __inline INT_PTR Netlib_Send(HANDLE hConn, const char *buf, int len, int flags) {
- NETLIBBUFFER nlb={(char*)buf, len, flags};
+ NETLIBBUFFER nlb = {(char*)buf, len, flags};
return CallService(MS_NETLIB_SEND, (WPARAM)hConn, (LPARAM)&nlb);
}
//Receive data over a connection
-//wParam=(WPARAM)(HANDLE)hConnection
-//lParam=(LPARAM)(NETLIBBUFFER*)&nlb
+//wParam = (WPARAM)(HANDLE)hConnection
+//lParam = (LPARAM)(NETLIBBUFFER*)&nlb
//Returns the number of bytes read on success, SOCKET_ERROR on failure,
//0 if the connection has been closed
//Flags supported: MSG_PEEK, MSG_NODUMP, MSG_DUMPPROXY, MSG_NOHTTPGATEWAYWRAP,
@@ -633,13 +633,13 @@ static __inline INT_PTR Netlib_Send(HANDLE hConn, const char *buf, int len, int // MS_NETLIB_SENDHTTPREQUEST
#define MS_NETLIB_RECV "Netlib/Recv"
static __inline INT_PTR Netlib_Recv(HANDLE hConn, char *buf, int len, int flags) {
- NETLIBBUFFER nlb={buf, len, flags};
+ NETLIBBUFFER nlb = {buf, len, flags};
return CallService(MS_NETLIB_RECV, (WPARAM)hConn, (LPARAM)&nlb);
}
//Determine the status of one or more connections
-//wParam=0
-//lParam=(LPARAM)(NETLIBSELECT*)&nls
+//wParam = 0
+//lParam = (LPARAM)(NETLIBSELECT*)&nls
//Returns the number of ready connections, SOCKET_ERROR on failure,
//0 if the timeout expired.
//All handles passed to this function must have been returned by either
@@ -672,15 +672,15 @@ typedef struct { #define MS_NETLIB_SELECTEX "Netlib/SelectEx"
//Shutdown connection
-//wParam=(WPARAM)(HANDLE)hConnection
-//lParam=(LPARAM)0
+//wParam = (WPARAM)(HANDLE)hConnection
+//lParam = (LPARAM)0
//Returns 0
#define MS_NETLIB_SHUTDOWN "Netlib/Shutdown"
__inline static void Netlib_Shutdown(HANDLE h) {CallService(MS_NETLIB_SHUTDOWN, (WPARAM)h, 0);}
//Create a packet receiver
-//wParam=(WPARAM)(HANDLE)hConnection
-//lParam=(LPARAM)(int)maxPacketSize
+//wParam = (WPARAM)(HANDLE)hConnection
+//lParam = (LPARAM)(int)maxPacketSize
//Returns a HANDLE on success, NULL on failure
//The packet receiver implements the common situation where you have variable
//length packets coming in over a connection and you want to split them up
@@ -691,8 +691,8 @@ __inline static void Netlib_Shutdown(HANDLE h) {CallService(MS_NETLIB_SHUTDOWN, #define MS_NETLIB_CREATEPACKETRECVER "Netlib/CreatePacketRecver"
//Get the next set of packets from a packet receiver
-//wParam=(WPARAM)(HANDLE)hPacketRecver
-//lParam=(LPARAM)(NETLIBPACKETRECVER*)&nlpr
+//wParam = (WPARAM)(HANDLE)hPacketRecver
+//lParam = (LPARAM)(NETLIBPACKETRECVER*)&nlpr
//Returns the total number of bytes available in the buffer, 0 if the
//connection was closed, SOCKET_ERROR on error.
//hPacketRecver must have been returned by MS_NETLIB_CREATEPACKETRECVER
@@ -719,8 +719,8 @@ typedef struct { #define MS_NETLIB_GETMOREPACKETS "Netlib/GetMorePackets"
//Add a message to the log (if it's running)
-//wParam=(WPARAM)(HANDLE)hUser
-//lParam=(LPARAM)(const char *)szMessage
+//wParam = (WPARAM)(HANDLE)hUser
+//lParam = (LPARAM)(const char *)szMessage
//Returns nonzero on success, 0 on failure ( !! this is different to most of the rest of Miranda, but consistent with netlib)
//Do not include a final line ending in szMessage.
//Errors: ERROR_INVALID_PARAMETER
@@ -728,15 +728,15 @@ typedef struct { #define MS_NETLIB_LOGW "Netlib/LogW"
//Sets a gateway polling timeout interval
-//wParam=(WPARAM)(HANDLE)hConn
-//lParam=(LPARAM)timeout
+//wParam = (WPARAM)(HANDLE)hConn
+//lParam = (LPARAM)timeout
//Returns previous timeout value
//Errors: -1
#define MS_NETLIB_SETPOLLINGTIMEOUT "Netlib/SetPollingTimeout"
//Makes connection SSL
-//wParam=(WPARAM)(HANDLE)hConn
-//lParam=(LPARAM)(NETLIBSSL*)&nlssl or null if no certficate validation required
+//wParam = (WPARAM)(HANDLE)hConn
+//lParam = (LPARAM)(NETLIBSSL*)&nlssl or null if no certficate validation required
//Returns 0 on failure 1 on success
#define MS_NETLIB_STARTSSL "Netlib/StartSsl"
diff --git a/include/m_options.h b/include/m_options.h index 5da817a71a..bc3469998a 100644 --- a/include/m_options.h +++ b/include/m_options.h @@ -30,8 +30,8 @@ extern int hLangpack; The user opened the options dialog. Modules should do whatever initialisation
they need and call opt/addpage one or more times if they want pages displayed
in the options dialog
-wParam=addInfo
-lParam=0
+wParam = addInfo
+lParam = 0
addInfo should be passed straight to the wParam of opt/addpage
*/
#define ME_OPT_INITIALISE "Opt/Initialise"
@@ -39,8 +39,8 @@ addInfo should be passed straight to the wParam of opt/addpage /* Opt/AddPage
Must only be called during an opt/initialise hook
Adds a page to the options dialog
-wParam=addInfo
-lParam=(LPARAM)(OPTIONSDIALOGPAGE*)odp
+wParam = addInfo
+lParam = (LPARAM)(OPTIONSDIALOGPAGE*)odp
addInfo must have come straight from the wParam of opt/initialise
Pages in the options dialog operate just like pages in property sheets. See the
Microsoft documentation for details on how they operate.
@@ -101,7 +101,7 @@ typedef struct { #define ODPF_TCHAR 0
#endif
-#define PSN_EXPERTCHANGED 2 //sent to pages via WM_NOTIFY when the expert checkbox is clicked. lParam=new state
+#define PSN_EXPERTCHANGED 2 //sent to pages via WM_NOTIFY when the expert checkbox is clicked. lParam = new state
#define PSM_ISEXPERT (WM_USER+101) //returns true/false
#define PSM_GETBOLDFONT (WM_USER+102) //returns HFONT used for group box titles
@@ -111,8 +111,8 @@ __inline static INT_PTR Options_AddPage(WPARAM wParam, OPTIONSDIALOGPAGE* odp) }
//Opens the options dialog, optionally at the specified page v0.1.2.1+
-//wParam=0
-//lParam=(LPARAM)(OPENOPTIONSDIALOG*)&ood;
+//wParam = 0
+//lParam = (LPARAM)(OPENOPTIONSDIALOG*)&ood;
//Returns 0 on success, nonzero on failure
//The behaviour if the options dialog is already open is that it will just be
//activated, the page won't be changed. This may change in the future.
diff --git a/include/m_popup.h b/include/m_popup.h index 54ce2cd09a..835cdff9e0 100644 --- a/include/m_popup.h +++ b/include/m_popup.h @@ -1,10 +1,10 @@ /*
- ===============================================================================
+ ============================================================================== =
PopUp plugin
Plugin Name: PopUp
Plugin authors: Luca Santarelli aka hrk (hrk@users.sourceforge.net)
Victor Pavlychko aka zazoo (nullbie@gmail.com)
- ===============================================================================
+ ============================================================================== =
The purpose of this plugin is to give developers a common "platform/interface"
to show PopUps. It is born from the source code of NewStatusNotify, another
plugin I've made.
@@ -12,7 +12,7 @@ plugin I've made. Remember that users *must* have this plugin enabled, or they won't get any
popup. Write this in the requirements, do whatever you wish ;-)... but tell
them!
- ===============================================================================
+ ============================================================================== =
*/
#ifndef M_POPUP_H
diff --git a/include/m_protocols.h b/include/m_protocols.h index 88553d6ae0..b659e078a3 100644 --- a/include/m_protocols.h +++ b/include/m_protocols.h @@ -29,8 +29,8 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #include "statusmodes.h"
//send a general request through the protocol chain for a contact
-//wParam=0
-//lParam=(LPARAM)(CCSDATA*)&ccs
+//wParam = 0
+//lParam = (LPARAM)(CCSDATA*)&ccs
//returns the value as documented in the PS_ definition (m_protosvc.h)
typedef struct {
@@ -43,8 +43,8 @@ typedef struct { #define MS_PROTO_CALLCONTACTSERVICE "Proto/CallContactService"
//a general network 'ack'
-//wParam=0
-//lParam=(LPARAM)(ACKDATA*)&ack
+//wParam = 0
+//lParam = (LPARAM)(ACKDATA*)&ack
//Note that just because definitions are here doesn't mean they will be sent.
//Read the documentation for the function you are calling to see what replies
//you will receive.
@@ -150,8 +150,8 @@ typedef struct tagPROTOFILETRANSFERSTATUS PROTOFILETRANSFERSTATUS;
//Enumerate the currently running protocols
-//wParam=(WPARAM)(int*)&numberOfProtocols
-//lParam=(LPARAM)(PROTOCOLDESCRIPTOR***)&ppProtocolDescriptors
+//wParam = (WPARAM)(int*)&numberOfProtocols
+//lParam = (LPARAM)(PROTOCOLDESCRIPTOR***)&ppProtocolDescriptors
//Returns 0 on success, nonzero on failure
//Neither wParam nor lParam may be NULL
//The list returned by this service is the protocol modules currently installed
@@ -215,15 +215,15 @@ typedef struct { #define MS_PROTO_ENUMPROTOCOLS "Proto/EnumAccounts"
//determines if a protocol module is loaded or not
-//wParam=0
-//lParam=(LPARAM)(const char*)szName
+//wParam = 0
+//lParam = (LPARAM)(const char*)szName
//Returns a pointer to the PROTOCOLDESCRIPTOR if the protocol is loaded, or
//NULL if it isn't.
#define MS_PROTO_ISPROTOCOLLOADED "Proto/IsProtocolLoaded"
//gets the network-level protocol associated with a contact
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=0
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = 0
//Returns a char* pointing to the asciiz name of the protocol or NULL if the
//contact has no protocol. There is no need to free() it or anything.
//This is the name of the module that actually accesses the network for that
@@ -231,8 +231,8 @@ typedef struct { #define MS_PROTO_GETCONTACTBASEPROTO "Proto/GetContactBaseProto"
//determines whether the specified contact has the given protocol in its chain
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=(LPARAM)(const char*)szName
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = (LPARAM)(const char*)szName
//Returns -1 if it is base protocol, positive number if it is filter and 0 if it doesn't
#define MS_PROTO_ISPROTOONCONTACT "Proto/IsProtoOnContact"
@@ -241,8 +241,8 @@ typedef struct { //This service is for notifying protocols that the user is typing a message v0.3.3+
//in a message dialog.
//This is typically sent by a message dialog when a user in the clist is typing.
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=(LPARAM)(int)typing state
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = (LPARAM)(int)typing state
//NOTE: Only protocols should generally call this service
#define MS_PROTO_SELFISTYPING "Proto/SelfIsTyping"
@@ -250,8 +250,8 @@ typedef struct { #define PROTOTYPE_CONTACTTYPING_INFINITE 2147483647
//This service is for notifying message dialogs/other plugins of a user typing. v0.3.3+
//This is typically sent by a protocol when a user in the clist is typing.
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=(LPARAM)(int)time (secs)
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = (LPARAM)(int)time (secs)
//NOTE: The time in seconds is used to tell a message dialog (or other plugin)
//how long to display its notification. If time is 0, then notification
//of typing ends.
@@ -263,8 +263,8 @@ typedef struct { //ProtoService PSS_USERISTYPING to the contacts protocol *after* verifying
//that the hContact is not NULL and the the user wishes to send notifications
//to this user (checked visibility, individual typing blocking, etc).
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=(LPARAM)(int)typing state
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = (LPARAM)(int)typing state
#define ME_PROTO_CONTACTISTYPING "Proto/ContactIsTypingEvent"
// -------------- accounts support --------------------- 0.8.0+
@@ -289,8 +289,8 @@ typedef struct tagACCOUNT PROTOACCOUNT;
//account enumeration service
-//wParam=(WPARAM)(int*)piNumAccounts
-//lParam=(LPARAM)(PROTOACCOUNT**)paAccounts
+//wParam = (WPARAM)(int*)piNumAccounts
+//lParam = (LPARAM)(PROTOACCOUNT**)paAccounts
#define MS_PROTO_ENUMACCOUNTS "Proto/EnumAccounts"
__inline static INT_PTR ProtoEnumAccounts(int* accNumber, PROTOACCOUNT*** accArray)
@@ -298,8 +298,8 @@ __inline static INT_PTR ProtoEnumAccounts(int* accNumber, PROTOACCOUNT*** accArr }
//retrieves an account's interface by its physical name (database module)
-//wParam=0
-//lParam=(LPARAM)(char*)szAccountName
+//wParam = 0
+//lParam = (LPARAM)(char*)szAccountName
//return value = PROTOACCOUNT* or NULL
#define MS_PROTO_GETACCOUNT "Proto/GetAccount"
@@ -321,8 +321,8 @@ __inline static PROTOACCOUNT* ProtoGetAccount(const char* accName) #define ME_PROTO_ACCLISTCHANGED "Proto/AccListChanged"
//displays the Account Manager
-//wParam=0
-//lParam=0
+//wParam = 0
+//lParam = 0
#define MS_PROTO_SHOWACCMGR "Protos/ShowAccountManager"
//determines if an account is enabled or not
@@ -344,8 +344,8 @@ __inline static int IsAccountEnabled(const PROTOACCOUNT* pa) //gets the account associated with a contact
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=0
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = 0
//Returns a char* pointing to the asciiz name of the protocol or NULL if the
//contact has no protocol. There is no need to mir_free() it or anything.
//This is the name of the module that actually accesses the network for that
diff --git a/include/m_protomod.h b/include/m_protomod.h index 887e673625..98928c0832 100644 --- a/include/m_protomod.h +++ b/include/m_protomod.h @@ -33,29 +33,29 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #include "m_protocols.h"
//notify the protocol manager that you're around
-//wParam=0
-//lParam=(PROTOCOLDESCRIPTOR*)&descriptor
+//wParam = 0
+//lParam = (PROTOCOLDESCRIPTOR*)&descriptor
//returns 0 on success, nonzero on failure
//This service must be called in your module's Load(void) routine.
//descriptor.type can be a value other than the PROTOTYPE_ constants specified
//above to provide more precise positioning information for the contact
//protocol lists. It is strongly recommended that you give values relative to
-//the constants, however, by adding or subtracting small integers (<=100).
+//the constants, however, by adding or subtracting small integers ( <= 100).
//PROTOTYPE_PROTOCOL modules must not do this. The value must be exact.
//See MS_PROTO_ENUMPROTOCOLS for more notes.
#define MS_PROTO_REGISTERMODULE "Proto/RegisterModule"
//adds the specified protocol module to the chain for a contact
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=(LPARAM)(const char*)szName
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = (LPARAM)(const char*)szName
//returns 0 on success, nonzero on failure
//The module is added in the correct position according to the type given when
//it was registered.
#define MS_PROTO_ADDTOCONTACT "Proto/AddToContact"
//removes the specified protocol module from the chain for a contact
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=(LPARAM)(const char*)szName
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = (LPARAM)(const char*)szName
//returns 0 on success, nonzero on failure
#define MS_PROTO_REMOVEFROMCONTACT "Proto/RemoveFromContact"
@@ -63,7 +63,7 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. //Protocol services are called with wParam and lParam as standard if they are
//to be called with CallProtoServiceInt(NULL,) (as PS_ services are)
//If they are called with CallContactService() (PSS_ and PSR_ services) then
-//they are called with lParam=(CCSDATA*)&ccs and wParam an opaque internal
+//they are called with lParam = (CCSDATA*)&ccs and wParam an opaque internal
//reference that should be passed unchanged to MS_PROTO_CHAIN*.
__inline static HANDLE CreateProtoServiceFunction(const char *szModule, const char *szService, MIRANDASERVICE serviceProc)
{
@@ -74,8 +74,8 @@ __inline static HANDLE CreateProtoServiceFunction(const char *szModule, const ch }
//Call the next service in the chain for this send operation
-//wParam=wParam
-//lParam=lParam
+//wParam = wParam
+//lParam = lParam
//The return value should be returned immediately
//wParam and lParam should be passed as the parameters that your service was
//called with. wParam must remain untouched but lParam is a CCSDATA structure
@@ -85,8 +85,8 @@ __inline static HANDLE CreateProtoServiceFunction(const char *szModule, const ch #define MS_PROTO_CHAINSEND "Proto/ChainSend"
//Call the next service in the chain for this receive operation
-//wParam=wParam
-//lParam=lParam
+//wParam = wParam
+//lParam = lParam
//The return value should be returned immediately
//wParam and lParam should be passed as the parameters that your service was
//called with. wParam must remain untouched but lParam is a CCSDATA structure
@@ -100,19 +100,19 @@ __inline static HANDLE CreateProtoServiceFunction(const char *szModule, const ch #define MS_PROTO_CHAINRECV "Proto/ChainRecv"
//Broadcast a ME_PROTO_ACK event
-//wParam=0
-//lParam=(LPARAM)(ACKDATA*)&ack
+//wParam = 0
+//lParam = (LPARAM)(ACKDATA*)&ack
//returns the return value of the notifyeventhooks() call
//Thread safety: me_proto_ack is completely thread safe since 0.1.2.0
//See the notes in core/modules.h under NotifyEventHooks()
#define MS_PROTO_BROADCASTACK "Proto/BroadcastAck"
__inline static INT_PTR ProtoBroadcastAck(const char *szModule, HANDLE hContact, int type, int result, HANDLE hProcess, LPARAM lParam)
{
- ACKDATA ack={0};
- ack.cbSize=sizeof(ACKDATA);
- ack.szModule=szModule; ack.hContact=hContact;
- ack.type=type; ack.result=result;
- ack.hProcess=hProcess; ack.lParam=lParam;
+ ACKDATA ack = {0};
+ ack.cbSize = sizeof(ACKDATA);
+ ack.szModule = szModule; ack.hContact = hContact;
+ ack.type = type; ack.result = result;
+ ack.hProcess = hProcess; ack.lParam = lParam;
return CallService(MS_PROTO_BROADCASTACK, 0, (LPARAM)&ack);
}
diff --git a/include/m_protosvc.h b/include/m_protosvc.h index f7ce4f26e9..1c6d04bb39 100644 --- a/include/m_protosvc.h +++ b/include/m_protosvc.h @@ -46,8 +46,8 @@ convert Unicode to ANSI and call the appropriate service. //these should be called with CallProtoServiceInt(NULL,)
//Get the capability flags of the module.
-//wParam=flagNum
-//lParam=0
+//wParam = flagNum
+//lParam = 0
//Returns a bitfield corresponding to wParam. See the #defines below
//Should return 0 for unknown values of flagNum
//Non-network-access modules should return flags to represent the things they
@@ -145,11 +145,11 @@ static __inline unsigned long Proto_Status2Flag(int status) #define PFLAG_UNIQUEIDTEXT 100 //returns a static buffer of text describing the unique field by which this protocol identifies users (already translated), or NULL
-#define PFLAG_MAXCONTACTSPERPACKET 200 //v0.1.2.2+: returns the maximum number of contacts which can be sent in a single PSS_CONTACTS, lParam=(LPARAM)hContact.
+#define PFLAG_MAXCONTACTSPERPACKET 200 //v0.1.2.2+: returns the maximum number of contacts which can be sent in a single PSS_CONTACTS, lParam = (LPARAM)hContact.
#define PFLAG_UNIQUEIDSETTING 300 // returns the setting name of where the unique id is stored
-#define PFLAG_MAXLENOFMESSAGE 400 // v0.3.2+: return the maximum length of an instant message, lParam=(LPARAM)hContact
+#define PFLAG_MAXLENOFMESSAGE 400 // v0.3.2+: return the maximum length of an instant message, lParam = (LPARAM)hContact
/*
@@ -188,8 +188,8 @@ will pick this up and everything will be good. #define PS_GETCAPS "/GetCaps"
//Get a human-readable name for the protocol
-//wParam=cchName
-//lParam=(LPARAM)(char*)szName
+//wParam = cchName
+//lParam = (LPARAM)(char*)szName
//Returns 0 on success, nonzero on failure
//cchName is the number of characters in the buffer szName
//This should be translated before being returned
@@ -198,8 +198,8 @@ will pick this up and everything will be good. #define PS_GETNAME "/GetName"
//Loads one of the protocol-specific icons
-//wParam=whichIcon
-//lParam=0
+//wParam = whichIcon
+//lParam = 0
//Returns the HICON, or NULL on failure
//The returned HICON must be DestroyIcon()ed.
//The UI should overlay the online icon with a further UI-specified icon to
@@ -214,14 +214,14 @@ will pick this up and everything will be good. #define PS_LOADICON "/LoadIcon"
//Change the protocol's status mode
-//wParam=newMode, from ui/contactlist/statusmodes.h
-//lParam=0
+//wParam = newMode, from ui/contactlist/statusmodes.h
+//lParam = 0
//returns 0 on success, nonzero on failure
//Will send an ack with:
-//type=ACKTYPE_STATUS, result=ACKRESULT_SUCCESS, hProcess=(HANDLE)previousMode, lParam=newMode
+//type = ACKTYPE_STATUS, result = ACKRESULT_SUCCESS, hProcess = (HANDLE)previousMode, lParam = newMode
//when the change completes. This ack is sent for all changes, not just ones
//caused by calling this function.
-//Note that newMode can be ID_STATUS_CONNECTING<=newMode<ID_STATUS_CONNECTING+
+//Note that newMode can be ID_STATUS_CONNECTING <= newMode<ID_STATUS_CONNECTING+
//MAX_CONNECT_RETRIES to signify that it's connecting and it's the nth retry.
//Protocols are initially always in offline mode.
//Non-network-level protocol modules do not have the concept of a status and
@@ -230,7 +230,7 @@ will pick this up and everything will be good. //closest one that it does support, and change to that.
//If the new mode requires that the protocol switch from offline to online then
//it will do so, but errors will be reported in the form of an additional ack:
-//type=ACKTYPE_LOGIN, result=ACKRESULT_FAILURE, hProcess=NULL, lParam=LOGINERR_
+//type = ACKTYPE_LOGIN, result = ACKRESULT_FAILURE, hProcess = NULL, lParam = LOGINERR_
// (added during 0.3.4.3) the protocol will send LOGINERR_OTHERLOCATION if the login
// was disconnected because of a login at another location
#define LOGINERR_WRONGPASSWORD 1
@@ -245,28 +245,28 @@ will pick this up and everything will be good. #define PS_SETSTATUS "/SetStatus"
//Sets the status-mode specific message for yourself
-//wParam=status mode
-//lParam=(LPARAM)(const char*)szMessage
+//wParam = status mode
+//lParam = (LPARAM)(const char*)szMessage
//Returns 0 on success, nonzero on failure
//Note that this service will not be available unless PF1_MODEMSGSEND is set
//and PF1_INDIVMODEMSG is *not* set.
//If PF1_INDIVMODEMSG is set, then see PSS_AWAYMSG for details of
//the operation of away messages
-//Protocol modules must support szMessage=NULL. It may either mean to use an
+//Protocol modules must support szMessage = NULL. It may either mean to use an
//empty message, or (preferably) to not reply at all to any requests
#define PS_SETAWAYMSG "/SetAwayMsg"
#define PS_SETAWAYMSGW "/SetAwayMsgW"
//Get the status mode that a protocol is currently in
-//wParam=lParam=0
+//wParam = lParam = 0
//Returns the status mode
//Non-network-level protocol modules do not have the concept of a status and
//should leave this service unimplemented
#define PS_GETSTATUS "/GetStatus"
//Allow somebody to add us to their contact list
-//wParam=(WPARAM)(HANDLE)hDbEvent
-//lParam=0
+//wParam = (WPARAM)(HANDLE)hDbEvent
+//lParam = 0
//Returns 0 on success, nonzero on failure
//Auth requests come in the form of an event added to the database for the NULL
//user. The form is:
@@ -277,21 +277,21 @@ will pick this up and everything will be good. #define PS_AUTHALLOW "/Authorize"
//Deny an authorisation request
-//wParam=(WPARAM)(HANDLE)hDbEvent
-//lParam=(LPARAM)(const TCHAR*)szReason
+//wParam = (WPARAM)(HANDLE)hDbEvent
+//lParam = (LPARAM)(const TCHAR*)szReason
//Returns 0 on success, nonzero on failure
-//Protocol modules must be able to cope with szReason=NULL
+//Protocol modules must be able to cope with szReason = NULL
#define PS_AUTHDENY "/AuthDeny"
#define PS_AUTHDENYW "/AuthDenyW"
// Send a "You were added" event
-// wParam=lParam=0
+// wParam = lParam = 0
// Returns 0 on success, nonzero on failure
#define PSS_ADDED "/YouWereAdded"
//Create account manager UI form
-//wParam=0
-//lParam=(LPARAM)(HWND)hwndAccMgr
+//wParam = 0
+//lParam = (LPARAM)(HWND)hwndAccMgr
//Returns handle on newly created form.
//Size for best fit is 186x134 DLUs, please avoid groupboxes
//paddind and advanced options. This should provide minimal setup
@@ -299,8 +299,8 @@ will pick this up and everything will be good. #define PS_CREATEACCMGRUI "/CreateAccMgrUI"
//Send a basic search request
-//wParam=0
-//lParam=(LPARAM)(const TCHAR*)szId
+//wParam = 0
+//lParam = (LPARAM)(const TCHAR*)szId
//Returns a handle for the search, or zero on failure
//All protocols identify users uniquely by a single field. This service will
//search by that field.
@@ -309,9 +309,9 @@ will pick this up and everything will be good. //All search replies (even protocol-specific extended searches) are replied by
//means of a series of acks:
//result acks, one of more of:
-//type=ACKTYPE_SEARCH, result=ACKRESULT_DATA, lParam=(LPARAM)(PROTOSEARCHRESULT*)&psr
+//type = ACKTYPE_SEARCH, result = ACKRESULT_DATA, lParam = (LPARAM)(PROTOSEARCHRESULT*)&psr
//ending ack:
-//type=ACKTYPE_SEARCH, result=ACKRESULT_SUCCESS, lParam=0
+//type = ACKTYPE_SEARCH, result = ACKRESULT_SUCCESS, lParam = 0
//Note that the pointers in the structure are not guaranteed to be valid after
//the ack is complete.
@@ -344,8 +344,8 @@ typedef struct { #define PS_BASICSEARCHW "/BasicSearchW"
//Search for users by e-mail address v0.1.2.1+
-//wParam=0
-//lParam=(LPARAM)(TCHAR*)szEmail
+//wParam = 0
+//lParam = (LPARAM)(TCHAR*)szEmail
//Returns a HANDLE to the search, or NULL on failure
//Results are returned as for PS_BASICSEARCH.
//This function is only available if the PF1_SEARCHBYEMAIL capability is set
@@ -356,8 +356,8 @@ typedef struct { #define PS_SEARCHBYEMAILW "/SearchByEmailW"
//Search for users by name v0.1.2.1+
-//wParam=0
-//lParam=(LPARAM)(PROTOSEARCHBYNAME*)&psbn
+//wParam = 0
+//lParam = (LPARAM)(PROTOSEARCHBYNAME*)&psbn
//Returns a HANDLE to the search, or NULL on failure
//Results are returned as for PS_BASICSEARCH.
//This function is only available if the PF1_SEARCHBYNAME capability is set
@@ -370,8 +370,8 @@ typedef struct { #define PS_SEARCHBYNAMEW "/SearchByNameW"
//Create the advanced search dialog box v0.1.2.1+
-//wParam=0
-//lParam=(HWND)hwndOwner
+//wParam = 0
+//lParam = (HWND)hwndOwner
//Returns a HWND, or NULL on failure
//This function is only available if the PF1_EXTSEARCHUI capability is set
//Advanced search is very protocol-specific so it is left to the protocol
@@ -384,8 +384,8 @@ typedef struct { #define PS_CREATEADVSEARCHUI "/CreateAdvSearchUI"
//Search using the advanced search dialog v0.1.2.1+
-//wParam=0
-//lParam=(LPARAM)(HWND)hwndAdvancedSearchDlg
+//wParam = 0
+//lParam = (LPARAM)(HWND)hwndAdvancedSearchDlg
//Returns a HANDLE to the search, or NULL on failure
//Results are returned as for PS_BASICSEARCH.
//This function is only available if the PF1_EXTSEARCHUI capability is set
@@ -399,21 +399,21 @@ typedef struct { } CUSTOMSEARCHRESULTS;
//Adds a search result to the contact list
-//wParam=flags
-//lParam=(LPARAM)(PROTOSEARCHRESULT*)&psr
+//wParam = flags
+//lParam = (LPARAM)(PROTOSEARCHRESULT*)&psr
//Returns a HANDLE to the new contact, or NULL on failure
//psr must be a result returned by a search function, since the extended
//information past the end of the official structure may contain important
//data required by the protocol.
//The protocol library should not allow duplicate contacts to be added, but if
//such a request is received it should return the original hContact, and do the
-//appropriate thing with the temporary flag (ie newflag=(oldflag&thisflag))
+//appropriate thing with the temporary flag (ie newflag = (oldflag&thisflag))
#define PALF_TEMPORARY 1 //add the contact temporarily and invisibly, just to get user info or something
#define PS_ADDTOLIST "/AddToList"
//Adds a contact to the contact list given an auth, added or contacts event
-//wParam=MAKEWPARAM(flags, iContact)
-//lParam=(LPARAM)(HANDLE)hDbEvent
+//wParam = MAKEWPARAM(flags, iContact)
+//lParam = (LPARAM)(HANDLE)hDbEvent
//Returns a HANDLE to the new contact, or NULL on failure
//hDbEvent must be either EVENTTYPE_AUTHREQ or EVENTTYPE_ADDED
//flags are the same as for PS_ADDTOLIST.
@@ -423,25 +423,25 @@ typedef struct { #define PS_ADDTOLISTBYEVENT "/AddToListByEvent"
//Changes our user details as stored on the server v0.1.2.0+
-//wParam=infoType
-//lParam=(LPARAM)(void*)pInfoData
+//wParam = infoType
+//lParam = (LPARAM)(void*)pInfoData
//Returns a HANDLE to the change request, or NULL on failure
//The details information that is stored on the server is very protocol-
//specific, so this service just supplies an outline for protocols to use.
//See protocol-specific documentation for what infoTypes are available and
//what pInfoData should be for each infoType.
-//Sends an ack type=ACKTYPE_SETINFO, result=ACKRESULT_SUCCESS/FAILURE,
-//lParam=0 on completion.
+//Sends an ack type = ACKTYPE_SETINFO, result = ACKRESULT_SUCCESS/FAILURE,
+//lParam = 0 on completion.
#define PS_CHANGEINFO "/ChangeInfo"
//Informs the protocol of the users chosen resume behaviour v0.1.2.2+
-//wParam=(WPARAM)(HANDLE)hFileTransfer
-//lParam=(LPARAM)(PROTOFILERESUME*)&pfr
+//wParam = (WPARAM)(HANDLE)hFileTransfer
+//lParam = (LPARAM)(PROTOFILERESUME*)&pfr
//Returns 0 on success, nonzero on failure
//If the protocol supports file resume (PF1_FILERESUME) then before each
//individual file receive begins (note: not just each file that already exists)
-//it will broadcast an ack with type=ACKTYPE_FILE, result=ACKRESULT_RESUME,
-//hProcess=hFileTransfer, lParam=(LPARAM)(PROTOFILETRANSFERSTATUS*)&fts. If the
+//it will broadcast an ack with type = ACKTYPE_FILE, result = ACKRESULT_RESUME,
+//hProcess = hFileTransfer, lParam = (LPARAM)(PROTOFILETRANSFERSTATUS*)&fts. If the
//UI processes this ack it must return nonzero from its hook. If all the hooks
//complete without returning nonzero then the protocol will assume that no
//resume UI was available and will continue the file receive with a default
@@ -463,20 +463,20 @@ typedef struct { #define PS_FILERESUMEW "/FileResumeW"
//Asks a protocol to join the chatroom from contact v0.8.0+
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=(LPARAM)0
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = (LPARAM)0
//Returns 0 on success, nonzero on failure
#define PS_JOINCHAT "/JoinChat"
//Asks a protocol to leave the chatroom from contact v0.8.0+
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=(LPARAM)0
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = (LPARAM)0
//Returns 0 on success, nonzero on failure
#define PS_LEAVECHAT "/LeaveChat"
//Asks a protocol to read contact information and translate them (for a lookup fields) v0.8.0+
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=(LPARAM)(DBCONTACTGETSETTING*)&dbcgs
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = (LPARAM)(DBCONTACTGETSETTING*)&dbcgs
//The flag PF4_INFOSETTINGSVC indicates that a protocol supports this. Basically it should
//do the same as MS_DB_CONTACT_GETSETTING_STR, except that for a lookup settings (e.g. Language)
//it returns string instead of an ID stored in the database.
@@ -488,8 +488,8 @@ typedef struct { #define PS_GETINFOSETTING "/GetInfoSetting"
// Asks protocol for the status message for a status
-// wParam=(WORD) 0 for current status or a status id
-// lParam=SGMA_xxx
+// wParam = (WORD) 0 for current status or a status id
+// lParam = SGMA_xxx
// Returns status msg or NULL if there is none. The protocol have to handle only the current
// status. Handling messages for other statuses is optional.
// Remember to mir_free the return value
@@ -504,9 +504,9 @@ typedef struct { #define PS_GETMYAWAYMSG "/GetMyAwayMsg"
// Set nickname for the user
-// wParam=(WPARAM)SMNN_xxx
-// lParam=(LPARAM)(char *) The new nickname for the user
-// return=0 for success
+// wParam = (WPARAM)SMNN_xxx
+// lParam = (LPARAM)(char *) The new nickname for the user
+// return = 0 for success
#define SMNN_UNICODE 1 // return Unicode status
#if defined(_UNICODE)
@@ -519,9 +519,9 @@ typedef struct { // Get the max allowed length for the user nickname
// Optional, default value is 1024
-// wParam=(WPARAM)0
-// lParam=(LPARAM)0
-// return= <=0 for error, >0 the max length of the nick
+// wParam = (WPARAM)0
+// lParam = (LPARAM)0
+// return = <= 0 for error, >0 the max length of the nick
#define PS_GETMYNICKNAMEMAXLENGTH "/GetMyNicknameMaxLength"
// WAYD = What are you doing
@@ -533,21 +533,21 @@ typedef struct { #endif
// Get the WAYD message for the user
-// wParam=(WPARAM)WAYD_xxx
-// lParam=(LPARAM)0
+// wParam = (WPARAM)WAYD_xxx
+// lParam = (LPARAM)0
// Returns the text or NULL if there is none. Remember to mir_free the return value.
#define PS_GETMYWAYD "/GetMyWAYD"
// Sets the WAYD message for the user
-// wParam=(WPARAM)WAYD_xxx
-// lParam=(LPARAM)(WCHAR * or char *)The message
+// wParam = (WPARAM)WAYD_xxx
+// lParam = (LPARAM)(WCHAR * or char *)The message
// Returns 0 on success, nonzero on failure
#define PS_SETMYWAYD "/SetMyWAYD"
// Get the max allowed length that a WAYD message can have
// Optional, default value is 1024
-// wParam=(WPARAM)0
-// lParam=(LPARAM)0
+// wParam = (WPARAM)0
+// lParam = (LPARAM)0
// Returns the max length
#define PS_GETMYWAYDMAXLENGTH "/GetMyWAYDMaxLength"
@@ -555,16 +555,16 @@ typedef struct { //these should be called with CallContactService()
//Updates a contact's details from the server
-//wParam=flags
-//lParam=0
+//wParam = flags
+//lParam = 0
//returns 0 on success, nonzero on failure
//Will update all the information in the database, and then send acks with
-//type=ACKTYPE_GETINFO, result=ACKRESULT_SUCCESS, hProcess=(HANDLE)(int)nReplies, lParam=thisReply
+//type = ACKTYPE_GETINFO, result = ACKRESULT_SUCCESS, hProcess = (HANDLE)(int)nReplies, lParam = thisReply
//Since some protocols do not allow the library to tell when it has got all
//the information so it can send a final ack, one ack will be sent after each
//chunk of data has been received. nReplies contains the number of distinct
//acks that will be sent to get all the information, thisReply is the zero-
-//based index of this ack. When thisReply=0 the 'minimal' information has just
+//based index of this ack. When thisReply = 0 the 'minimal' information has just
//been received. All other numbering is arbitrary.
#define SGIF_MINIMAL 1 //get only the most basic information. This should
//contain at least a Nick and e-mail.
@@ -572,65 +572,65 @@ typedef struct { #define PSS_GETINFO "/GetInfo"
//Send an instant message
-//wParam=flags
-//lParam=(LPARAM)(const char*)szMessage
+//wParam = flags
+//lParam = (LPARAM)(const char*)szMessage
//returns a hProcess corresponding to the one in the ack event.
//Will send an ack when the message actually gets sent
-//type=ACKTYPE_MESSAGE, result=success/failure, (char*)lParam=error message or NULL.
+//type = ACKTYPE_MESSAGE, result = success/failure, (char*)lParam = error message or NULL.
//Protocols modules are free to define flags starting at 0x10000
//The event will *not* be added to the database automatically.
#define PSS_MESSAGE "/SendMsg"
//Send an URL message
-//wParam=flags
-//lParam=(LPARAM)(const char*)szMessage
+//wParam = flags
+//lParam = (LPARAM)(const char*)szMessage
//returns a hProcess corresponding to the one in the ack event.
//szMessage should be encoded as the URL followed by the description, the
//separator being a single nul (\0). If there is no description, do not forget
//to end the URL with two nuls.
//Will send an ack when the message actually gets sent
-//type=ACKTYPE_URL, result=success/failure, (char*)lParam=error message or NULL.
+//type = ACKTYPE_URL, result = success/failure, (char*)lParam = error message or NULL.
//Protocols modules are free to define flags starting at 0x10000
//The event will *not* be added to the database automatically.
#define PSS_URL "/SendUrl"
//Send a set of contacts
-//wParam=MAKEWPARAM(flags, nContacts)
-//lParam=(LPARAM)(HANDLE*)hContactsList
+//wParam = MAKEWPARAM(flags, nContacts)
+//lParam = (LPARAM)(HANDLE*)hContactsList
//returns a hProcess corresponding to the one in the ack event, NULL on
//failure.
//hContactsList is an array of nContacts handles to contacts. If this array
//includes one or more contacts that cannot be transferred using this protocol
//the function will fail.
//Will send an ack when the contacts actually get sent
-//type=ACKTYPE_CONTACTS, result=success/failure, (char*)lParam=error message or NULL.
+//type = ACKTYPE_CONTACTS, result = success/failure, (char*)lParam = error message or NULL.
//No flags have yet been defined.
//The event will *not* be added to the database automatically.
#define PSS_CONTACTS "/SendContacts"
//Send a request to retrieve somebody's mode message.
-//wParam=lParam=0
+//wParam = lParam = 0
//returns an hProcess identifying the request, or 0 on failure
//This function will fail if the contact's current status mode doesn't have an
//associated message
//The reply will be in the form of an ack:
-//type=ACKTYPE_AWAYMSG, result=success/failure, lParam=(const char*)szMessage
+//type = ACKTYPE_AWAYMSG, result = success/failure, lParam = (const char*)szMessage
#define PSS_GETAWAYMSG "/GetAwayMsg"
//Sends an away message reply to a user
-//wParam=(WPARAM)(HANDLE)hProcess (of ack)
-//lParam=(LPARAM)(const char*)szMessage
+//wParam = (WPARAM)(HANDLE)hProcess (of ack)
+//lParam = (LPARAM)(const char*)szMessage
//Returns 0 on success, nonzero on failure
//This function must only be used if the protocol has PF1_MODEMSGSEND and
//PF1_INDIVMODEMSG set. Otherwise, PS_SETAWAYMESSAGE should be used.
//This function must only be called in response to an ack that a user has
//requested our away message. The ack is sent as:
-//type=ACKTYPE_AWAYMSG, result=ACKRESULT_SENTREQUEST, lParam=0
+//type = ACKTYPE_AWAYMSG, result = ACKRESULT_SENTREQUEST, lParam = 0
#define PSS_AWAYMSG "/SendAwayMsg"
//Allows a file transfer to begin
-//wParam=(WPARAM)(HANDLE)hTransfer
-//lParam=(LPARAM)(const TCHAR*)szPath
+//wParam = (WPARAM)(HANDLE)hTransfer
+//lParam = (LPARAM)(const TCHAR*)szPath
//Returns a new handle to the transfer, to be used from now on
//If szPath does not point to a directory then:
// if a single file is being transferred and the protocol supports file
@@ -645,47 +645,47 @@ typedef struct { #define PSS_FILEALLOWW "/FileAllowW"
//Refuses a file transfer request
-//wParam=(WPARAM)(HANDLE)hTransfer
-//lParam=(LPARAM)(const TCHAR*)szReason
+//wParam = (WPARAM)(HANDLE)hTransfer
+//lParam = (LPARAM)(const TCHAR*)szReason
//Returns 0 on success, nonzero on failure
#define PSS_FILEDENY "/FileDeny"
#define PSS_FILEDENYW "/FileDenyW"
//Cancel an in-progress file transfer
-//wParam=(WPARAM)(HANDLE)hTransfer
-//lParam=0
+//wParam = (WPARAM)(HANDLE)hTransfer
+//lParam = 0
//Returns 0 on success, nonzero on failure
#define PSS_FILECANCEL "/FileCancel"
//Initiate a file send
-//wParam=(WPARAM)(const TCHAR*)szDescription
-//lParam=(LPARAM)(TCHAR **)ppszFiles
+//wParam = (WPARAM)(const TCHAR*)szDescription
+//lParam = (LPARAM)(TCHAR **)ppszFiles
//Returns a transfer handle on success, NULL on failure
-//All notification is done through acks, with type=ACKTYPE_FILE
-//If result=ACKRESULT_FAILED then lParam=(LPARAM)(const char*)szReason
+//All notification is done through acks, with type = ACKTYPE_FILE
+//If result = ACKRESULT_FAILED then lParam = (LPARAM)(const char*)szReason
#define PSS_FILE "/SendFile"
#define PSS_FILEW "/SendFileW"
//Set the status mode you will appear in to a user
-//wParam=statusMode
-//lParam=0
+//wParam = statusMode
+//lParam = 0
//Returns 0 on success, nonzero on failure
-//Set statusMode=0 to revert to normal behaviour for the contact
+//Set statusMode = 0 to revert to normal behaviour for the contact
//ID_STATUS_ONLINE is possible iff PF1_VISLIST
//ID_STATUS_OFFLINE is possible iff PF1_INVISLIST
//Other modes are possible iff PF1_INDIVSTATUS
#define PSS_SETAPPARENTMODE "/SetApparentMode"
// Send an auth request
-// wParam=0
-// lParam=(const TCHAR *)szMessage
+// wParam = 0
+// lParam = (const TCHAR *)szMessage
// Returns 0 on success, nonzero on failure
#define PSS_AUTHREQUEST "/AuthRequest"
#define PSS_AUTHREQUESTW "/AuthRequestW"
// Send "User is Typing" (user is typing a message to the user) v0.3.3+
-// wParam=(WPARAM)(HANDLE)hContact
-// lParam=(LPARAM)(int)typing type - see PROTOTYPE_SELFTYPING_X defines in m_protocols.h
+// wParam = (WPARAM)(HANDLE)hContact
+// lParam = (LPARAM)(int)typing type - see PROTOTYPE_SELFTYPING_X defines in m_protocols.h
#define PSS_USERISTYPING "/UserIsTyping"
/**************************** RECEIVING SERVICES *************************/
@@ -708,8 +708,8 @@ typedef struct { //In all cases, the database should store what the user read/wrote.
//An instant message has been received
-//wParam=0
-//lParam=(LPARAM)(PROTORECVEVENT*)&pre
+//wParam = 0
+//lParam = (LPARAM)(PROTORECVEVENT*)&pre
//DB event: EVENTTYPE_MESSAGE, blob contains szMessage without 0 terminator
//Return 0 - success, other failure
typedef struct {
@@ -737,15 +737,15 @@ typedef struct { #define MS_PROTO_RECVMSG "Proto/RecvMessage"
//An URL has been received
-//wParam=0
-//lParam=(LPARAM)(PROTORECVEVENT*)&pre
+//wParam = 0
+//lParam = (LPARAM)(PROTORECVEVENT*)&pre
//szMessage is encoded the same as for PSS_URL
//DB event: EVENTTYPE_URL, blob contains szMessage without 0 terminator
#define PSR_URL "/RecvUrl"
//Contacts have been received
-//wParam=0
-//lParam=(LPARAM)(PROTORECVEVENT*)&pre
+//wParam = 0
+//lParam = (LPARAM)(PROTORECVEVENT*)&pre
//pre.szMessage is actually a (PROTOSEARCHRESULT**) list.
//pre.lParam is the number of contacts in that list.
//pre.flags can contain PREF_UTF defining the strings as utf-8 encoded (0.7.0+)
@@ -768,8 +768,8 @@ Use PS_ADDTOLISTBYEVENT to add the contacts from one of these to the list. */
//File(s) have been received (0.9.x)
-//wParam=0
-//lParam=(LPARAM)(PROTORECVFILE*)&prf
+//wParam = 0
+//lParam = (LPARAM)(PROTORECVFILE*)&prf
typedef struct {
DWORD flags;
DWORD timestamp; //unix time
@@ -795,13 +795,13 @@ typedef struct { #define MS_PROTO_RECVFILE "Proto/RecvFile"
//An away message reply has been received
-//wParam=statusMode
-//lParam=(LPARAM)(PROTORECVEVENT*)&pre
+//wParam = statusMode
+//lParam = (LPARAM)(PROTORECVEVENT*)&pre
#define PSR_AWAYMSG "/RecvAwayMsg"
//An authorization request has been received
-//wParam=0
-//lParam=(LPARAM)(PROTORECVEVENT*)&pre
+//wParam = 0
+//lParam = (LPARAM)(PROTORECVEVENT*)&pre
//pre.szMessage is same format as blob
//pre.lParam is the size of the blob
#define PSR_AUTH "/RecvAuth"
diff --git a/include/m_skin.h b/include/m_skin.h index aa36735ab0..6f49171901 100644 --- a/include/m_skin.h +++ b/include/m_skin.h @@ -27,8 +27,8 @@ extern int hLangpack; //loads an icon from the user's custom skin library, or from the exe if there
//isn't one of them
-//wParam=id of icon to load - see below
-//lParam=0
+//wParam = id of icon to load - see below
+//lParam = 0
//returns an hIcon for the new icon. Do *not* DestroyIcon() the return value
//returns NULL if id is invalid, but will always succeed for a valid id
#define MS_SKIN_LOADICON "Skin/Icons/Load"
@@ -104,8 +104,8 @@ __inline static HICON LoadSkinnedIconBig(int id) {return (HICON)CallService(MS_S #define SKINICON_STATUS_OUTTOLUNCH 9
//Loads an icon representing the status mode for a particular protocol.
-//wParam=(WPARAM)(const char*)szProto
-//lParam=status
+//wParam = (WPARAM)(const char*)szProto
+//lParam = status
//returns an hIcon for the new icon. Do *not* DestroyIcon() the return value
//returns NULL on failure
//if szProto is NULL the function will load the user's selected 'all protocols'
@@ -117,8 +117,8 @@ __inline static HICON LoadSkinnedProtoIcon(const char *szProto, int status) {ret __inline static HICON LoadSkinnedProtoIconBig(const char *szProto, int status) {return (HICON)CallService(MS_SKIN_LOADPROTOICONBIG, (WPARAM)szProto, status);}
//add a new sound so it has a default and can be changed in the options dialog
-//wParam=hLangpack
-//lParam=(LPARAM)(SKINSOUNDDESC*)ssd;
+//wParam = hLangpack
+//lParam = (LPARAM)(SKINSOUNDDESC*)ssd;
//returns 0 on success, nonzero otherwise
#define SSDF_UNICODE 0x0001
@@ -161,7 +161,7 @@ __inline static INT_PTR SkinAddNewSoundEx(const char *name, const char *section, __inline static INT_PTR SkinAddNewSound(const char *name, const char *description, const char *defaultFile)
{
SKINSOUNDDESCEX ssd = { 0 };
- ssd.cbSize=sizeof(ssd);
+ ssd.cbSize = sizeof(ssd);
ssd.pszName = name;
ssd.pszDescription = description;
ssd.pszDefaultFile = defaultFile;
@@ -185,8 +185,8 @@ __inline static INT_PTR Skin_AddSound(SKINSOUNDDESCEX *ssd) }
//play a named sound event
-//wParam=0
-//lParam=(LPARAM)(const char*)pszName
+//wParam = 0
+//lParam = (LPARAM)(const char*)pszName
//pszName should have been added with Skin/Sounds/AddNew, but if not the
//function will not fail, it will play the Windows default sound instead.
#define MS_SKIN_PLAYSOUND "Skin/Sounds/Play"
@@ -198,7 +198,7 @@ __inline static INT_PTR SkinPlaySound(const char *name) //sent when the icons DLL has been changed in the options dialog, and everyone
//should re-make their image lists
-//wParam=lParam=0
+//wParam = lParam = 0
#define ME_SKIN_ICONSCHANGED "Skin/IconsChanged"
diff --git a/include/m_system.h b/include/m_system.h index db912fd32c..7d9e508f55 100644 --- a/include/m_system.h +++ b/include/m_system.h @@ -25,7 +25,7 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #include <tchar.h>
- +
#ifndef MIRANDANAME
#define MIRANDANAME "Miranda IM"
#endif
@@ -45,58 +45,59 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #define __forceinline static FORCEINLINE
#else
#pragma warning(disable:4244 4245)
-#endif
+#endif
+
#include <m_core.h>
- +
//miranda/system/modulesloaded
//called after all modules have been successfully initialised
-//wParam=lParam=0
+//wParam = lParam = 0
//used to resolve double-dependencies in the module load order
#define ME_SYSTEM_MODULESLOADED "Miranda/System/ModulesLoaded"
//miranda/system/shutdown event
//called just before the application terminates
//the database is still guaranteed to be running during this hook.
-//wParam=lParam=0
+//wParam = lParam = 0
#define ME_SYSTEM_SHUTDOWN "Miranda/System/Shutdown"
//restarts miranda (0.8+)
-//wParam=lParam=0
+//wParam = lParam = 0
#define MS_SYSTEM_RESTART "Miranda/System/Restart"
//miranda/system/oktoexit event
//called before the app goes into shutdown routine to make sure everyone is
//happy to exit
-//wParam=lParam=0
+//wParam = lParam = 0
//return nonzero to stop the exit cycle
#define ME_SYSTEM_OKTOEXIT "Miranda/System/OkToExitEvent"
//miranda/system/oktoexit service
//Check if everyone is happy to exit
-//wParam=lParam=0
+//wParam = lParam = 0
//if everyone acknowleges OK to exit then returns true, otherwise false
#define MS_SYSTEM_OKTOEXIT "Miranda/System/OkToExit"
//gets the version number of Miranda encoded as a DWORD v0.1.0.1+
-//wParam=lParam=0
+//wParam = lParam = 0
//returns the version number, encoded as one version per byte, therefore
//version 1.2.3.10 is 0x0102030a
#define MS_SYSTEM_GETVERSION "Miranda/System/GetVersion"
//gets the version of Miranda encoded as text v0.1.0.1+
-//wParam=cch
-//lParam=(LPARAM)(char*)pszVersion
+//wParam = cch
+//lParam = (LPARAM)(char*)pszVersion
//cch is the size of the buffer pointed to by pszVersion, in bytes
//may return a build qualifier, such as "0.1.0.1 alpha"
//returns 0 on success, nonzero on failure
#define MS_SYSTEM_GETVERSIONTEXT "Miranda/System/GetVersionText"
//Adds a HANDLE to the list to be checked in the main message loop v0.1.2.0+
-//wParam=(WPARAM)(HANDLE)hObject
-//lParam=(LPARAM)(const char*)pszService
+//wParam = (WPARAM)(HANDLE)hObject
+//lParam = (LPARAM)(const char*)pszService
//returns 0 on success or nonzero on failure
-//Causes pszService to be CallService()d (wParam=hObject, lParam=0) from the
+//Causes pszService to be CallService()d (wParam = hObject, lParam = 0) from the
//main thread whenever hObject is signalled.
//The Miranda message loop has a MsgWaitForMultipleObjects() call in it to
//implement this feature. See the documentation for that function for
@@ -128,14 +129,14 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #define MS_SYSTEM_WAITONHANDLE "Miranda/System/WaitOnHandle"
//Removes a HANDLE from the wait list v0.1.2.0+
-//wParam=(WPARAM)(HANDLE)hObject
-//lParam=0
+//wParam = (WPARAM)(HANDLE)hObject
+//lParam = 0
//returns 0 on success or nonzero on failure.
#define MS_SYSTEM_REMOVEWAIT "Miranda/System/RemoveWait"
/*
-wParam=0
-lParam=0
+wParam = 0
+lParam = 0
This hook is fired just before the thread unwind stack is used,
it allows MT plugins to shutdown threads if they have any special
@@ -145,8 +146,8 @@ processing to do, etc. #define ME_SYSTEM_PRESHUTDOWN "Miranda/System/PShutdown"
/*
-wParam=0
-lParam=0
+wParam = 0
+lParam = 0
Returns TRUE when Miranda has got WM_QUIT and is in the process
of shutting down
diff --git a/include/m_system_cpp.h b/include/m_system_cpp.h index 0b79d4d552..c42bd68272 100644 --- a/include/m_system_cpp.h +++ b/include/m_system_cpp.h @@ -44,7 +44,7 @@ public: __inline mir_ptr() : data((T*)mir_calloc(sizeof(T))) {}
__inline mir_ptr(T* _p) : data(_p) {}
__inline ~mir_ptr() { mir_free(data); }
- __inline T* operator= (T* _p) { if (data) mir_free(data); data = _p; return data; }
+ __inline T* operator = (T* _p) { if (data) mir_free(data); data = _p; return data; }
__inline T* operator->() const { return data; }
__inline operator T*() const { return data; }
__inline operator INT_PTR() const { return (INT_PTR)data; }
@@ -94,7 +94,7 @@ template<class T> struct LIST List_Copy((SortedList*)&x, (SortedList*)this, sizeof(T));
}
- __inline LIST& operator=(const LIST& x)
+ __inline LIST& operator = (const LIST& x)
{ destroy();
List_Copy((SortedList*)&x, (SortedList*)this, sizeof(T));
return *this;
@@ -139,7 +139,7 @@ template<class T> struct OBJLIST : public LIST<T> List_ObjCopy((SortedList*)&x, (SortedList*)this, sizeof(T));
}
- __inline OBJLIST& operator=(const OBJLIST& x)
+ __inline OBJLIST& operator = (const OBJLIST& x)
{ destroy();
List_ObjCopy((SortedList*)&x, (SortedList*)this, sizeof(T));
return *this;
diff --git a/include/m_url.h b/include/m_url.h index 1ca41eac5b..d544839c8a 100644 --- a/include/m_url.h +++ b/include/m_url.h @@ -25,8 +25,8 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #define M_URL_H__ 1
//bring up the send URL dialog for a user
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=0
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = 0
//returns 0 on success or nonzero on failure
//returns immediately, before the url is sent
#define MS_URL_SENDURL "SRUrl/SendCommand"
diff --git a/include/m_userinfo.h b/include/m_userinfo.h index e19b08211c..79a64b6c07 100644 --- a/include/m_userinfo.h +++ b/include/m_userinfo.h @@ -27,16 +27,16 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #include "m_options.h"
//show the User Details dialog box
-//wParam=(WPARAM)(HANDLE)hContact
-//lParam=0
+//wParam = (WPARAM)(HANDLE)hContact
+//lParam = 0
#define MS_USERINFO_SHOWDIALOG "UserInfo/ShowDialog"
/* UserInfo/Initialise v0.1.2.0+
The user opened a details dialog. Modules should do whatever initialisation
they need and call userinfo/addpage one or more times if they want pages
displayed in the options dialog
-wParam=addInfo
-lParam=(LPARAM)hContact
+wParam = addInfo
+lParam = (LPARAM)hContact
addInfo should be passed straight to the wParam of userinfo/addpage
NB: The built-in userinfo module is loaded after all plugins, so calling
HookEvent() in your plugin's Load(void) function will fail if you specify this
@@ -47,12 +47,12 @@ hook. Look up core/m_system.h:me_system_modulesloaded. /* UserInfo/AddPage v0.1.2.0+
Must only be called during an userinfo/initialise hook
Adds a page to the details dialog
-wParam=addInfo
-lParam=(LPARAM)(OPTIONSDIALOGPAGE*)odp
+wParam = addInfo
+lParam = (LPARAM)(OPTIONSDIALOGPAGE*)odp
addInfo must have come straight from the wParam of userinfo/initialise
Pages in the details dialog operate just like pages in property sheets. See the
Microsoft documentation for info on how they operate.
-When the pages receive WM_INITDIALOG, lParam=(LPARAM)hContact
+When the pages receive WM_INITDIALOG, lParam = (LPARAM)hContact
Strings in the structure can be released as soon as the service returns, but
icons must be kept around. This is not a problem if you're loading them from a
resource
@@ -61,11 +61,11 @@ Unlike the options dialog, the details dialog does not resize to fit its largest page. Details dialog pages should be 222x132 dlus.
The details dialog (currently) has no Cancel button. I'm waiting to see if it's
sensible to have one.
-Pages will be sent PSN_INFOCHANGED through WM_NOTIFY (idFrom=0) when a protocol
-ack is broadcast for the correct contact and with type=ACKTYPE_GETINFO.
+Pages will be sent PSN_INFOCHANGED through WM_NOTIFY (idFrom = 0) when a protocol
+ack is broadcast for the correct contact and with type = ACKTYPE_GETINFO.
To help you out, PSN_INFOCHANGED will also be sent to each page just after it's
created.
-All PSN_ WM_NOTIFY messages have PSHNOTIFY.lParam=(LPARAM)hContact
+All PSN_ WM_NOTIFY messages have PSHNOTIFY.lParam = (LPARAM)hContact
*/
#define PSN_INFOCHANGED 1
#define PSN_PARAMCHANGED 2
diff --git a/include/m_utils.h b/include/m_utils.h index 57cde573e4..ddeb1d2b15 100644 --- a/include/m_utils.h +++ b/include/m_utils.h @@ -62,8 +62,8 @@ running, one will be opened to show the URL. /* Resizes a dialog by calling a custom routine to move the individual
controls v0.1.0.1+
-wParam=0
-lParam=(LPARAM)(UTILRESIZEDIALOG*)&urd
+wParam = 0
+lParam = (LPARAM)(UTILRESIZEDIALOG*)&urd
Returns 0 on success, or nonzero on failure
Does not support dialogtemplateex dialog boxes, and will return failure if you
try to resize one
@@ -102,16 +102,16 @@ typedef struct { #define MS_UTILS_RESIZEDIALOG "Utils/ResizeDialog"
/* Gets the name of a country given its number v0.1.2.0+
-wParam=countryId
-lParam=0
+wParam = countryId
+lParam = 0
Returns a pointer to the string containing the country name on success,
or NULL on failure
*/
#define MS_UTILS_GETCOUNTRYBYNUMBER "Utils/GetCountryByNumber"
/* Gets the full list of country IDs v0.1.2.0+
-wParam=(WPARAM)(int*)piCount
-lParam=(LPARAM)(struct CountryListEntry**)ppList
+wParam = (WPARAM)(int*)piCount
+lParam = (LPARAM)(struct CountryListEntry**)ppList
Returns 0 always
Neither wParam nor lParam can be NULL.
The list is sorted alphabetically by country name, on the assumption that it's
@@ -126,13 +126,13 @@ struct CountryListEntry { /******************************* Window lists *******************************/
//allocate a window list v0.1.0.1+
-//wParam=lParam=0
+//wParam = lParam = 0
//returns a handle to the new window list
#define MS_UTILS_ALLOCWINDOWLIST "Utils/AllocWindowList"
//adds a window to the specified window list v0.1.0.1+
-//wParam=0
-//lParam=(LPARAM)(WINDOWLISTENTRY*)&wle
+//wParam = 0
+//lParam = (LPARAM)(WINDOWLISTENTRY*)&wle
//returns 0 on success, nonzero on failure
typedef struct {
HANDLE hList;
@@ -142,12 +142,12 @@ typedef struct { #define MS_UTILS_ADDTOWINDOWLIST "Utils/AddToWindowList"
__inline static INT_PTR WindowList_Add(HANDLE hList, HWND hwnd, HANDLE hContact) {
WINDOWLISTENTRY wle;
- wle.hList=hList; wle.hwnd=hwnd; wle.hContact=hContact;
+ wle.hList = hList; wle.hwnd = hwnd; wle.hContact = hContact;
return CallService(MS_UTILS_ADDTOWINDOWLIST, 0, (LPARAM)&wle);
}
//removes a window from the specified window list v0.1.0.1+
-//wParam=(WPARAM)(HANDLE)hList
-//lParam=(LPARAM)(HWND)hwnd
+//wParam = (WPARAM)(HANDLE)hList
+//lParam = (LPARAM)(HWND)hwnd
//returns 0 on success, nonzero on failure
#define MS_UTILS_REMOVEFROMWINDOWLIST "Utils/RemoveFromWindowList"
__inline static INT_PTR WindowList_Remove(HANDLE hList, HWND hwnd) {
@@ -155,8 +155,8 @@ __inline static INT_PTR WindowList_Remove(HANDLE hList, HWND hwnd) { }
//finds a window given the hContact v0.1.0.1+
-//wParam=(WPARAM)(HANDLE)hList
-//lParam=(WPARAM)(HANDLE)hContact
+//wParam = (WPARAM)(HANDLE)hList
+//lParam = (WPARAM)(HANDLE)hContact
//returns the window handle on success, or NULL on failure
#define MS_UTILS_FINDWINDOWINLIST "Utils/FindWindowInList"
__inline static HWND WindowList_Find(HANDLE hList, HANDLE hContact) {
@@ -164,14 +164,14 @@ __inline static HWND WindowList_Find(HANDLE hList, HANDLE hContact) { }
//broadcasts a message to all windows in a list v0.1.0.1+
-//wParam=(WPARAM)(HANDLE)hList
-//lParam=(LPARAM)(MSG*)&msg
+//wParam = (WPARAM)(HANDLE)hList
+//lParam = (LPARAM)(MSG*)&msg
//returns 0 on success, nonzero on failure
//Only msg.message, msg.wParam and msg.lParam are used
#define MS_UTILS_BROADCASTTOWINDOWLIST "Utils/BroadcastToWindowList"
__inline static INT_PTR WindowList_Broadcast(HANDLE hList, UINT message, WPARAM wParam, LPARAM lParam) {
MSG msg;
- msg.message=message; msg.wParam=wParam; msg.lParam=lParam;
+ msg.message = message; msg.wParam = wParam; msg.lParam = lParam;
return CallService(MS_UTILS_BROADCASTTOWINDOWLIST, (WPARAM)hList, (LPARAM)&msg);
}
@@ -180,8 +180,8 @@ __inline static INT_PTR WindowList_Broadcast(HANDLE hList, UINT message, WPARAM Version: 0.3.0.0+
Inline helper: WindowList_BroadcastAsync
- wParam=(WPARAM)(HANDLE)hList
- lParam=(LPARAM)(MSG*)&msg
+ wParam = (WPARAM)(HANDLE)hList
+ lParam = (LPARAM)(MSG*)&msg
Returns 0 on success, nonzero on failure, this service does not fail, even if PostMessage() fails for whatever reason
@@ -190,7 +190,7 @@ __inline static INT_PTR WindowList_Broadcast(HANDLE hList, UINT message, WPARAM __inline static INT_PTR WindowList_BroadcastAsync(HANDLE hList, UINT message, WPARAM wParam, LPARAM lParam) {
MSG msg;
- msg.message=message; msg.wParam=wParam; msg.lParam=lParam;
+ msg.message = message; msg.wParam = wParam; msg.lParam = lParam;
return CallService(MS_UTILS_BROADCASTTOWINDOWLIST_ASYNC, (WPARAM)hList, (LPARAM)&msg);
}
@@ -202,19 +202,19 @@ __inline static INT_PTR WindowList_BroadcastAsync(HANDLE hList, UINT message, WP //the control will send STN_CLICKED via WM_COMMAND when the link itself is clicked
// Use this in a SendMessage to set the color of the url when control is enabled
-// wParam=DWORD color
-// lParam=not used
+// wParam = DWORD color
+// lParam = not used
#define HLK_SETENABLECOLOUR (WM_USER+101) // added in 0.3.1
// Use this in a SendMessage to set the color of the url when control is disabled
-// wParam=DWORD color
-// lParam=not used
+// wParam = DWORD color
+// lParam = not used
#define HLK_SETDISABLECOLOUR (WM_USER+102) // added in 0.3.1
/***************************** Window Position Saving ***************************/
//saves the position of a window in the database v0.1.1.0+
-//wParam=0
-//lParam=(LPARAM)(SAVEWINDOWPOS*)&swp
+//wParam = 0
+//lParam = (LPARAM)(SAVEWINDOWPOS*)&swp
//returns 0 on success, nonzero on failure
typedef struct {
HWND hwnd;
@@ -225,13 +225,13 @@ typedef struct { #define MS_UTILS_SAVEWINDOWPOSITION "Utils/SaveWindowPos"
__inline static INT_PTR Utils_SaveWindowPosition(HWND hwnd, HANDLE hContact, const char *szModule, const char *szNamePrefix) {
SAVEWINDOWPOS swp;
- swp.hwnd=hwnd; swp.hContact=hContact; swp.szModule=szModule; swp.szNamePrefix=szNamePrefix;
+ swp.hwnd = hwnd; swp.hContact = hContact; swp.szModule = szModule; swp.szNamePrefix = szNamePrefix;
return CallService(MS_UTILS_SAVEWINDOWPOSITION, 0, (LPARAM)&swp);
}
//restores the position of a window from the database v0.1.1.0+
-//wParam=flags
-//lParam=(LPARAM)(SAVEWINDOWPOS*)&swp
+//wParam = flags
+//lParam = (LPARAM)(SAVEWINDOWPOS*)&swp
//returns 0 on success, nonzero on failure
//if no position was found in the database, the function returns 1 and does
//nothing
@@ -244,7 +244,7 @@ __inline static INT_PTR Utils_SaveWindowPosition(HWND hwnd, HANDLE hContact, con #define MS_UTILS_RESTOREWINDOWPOSITION "Utils/RestoreWindowPos"
__inline static INT_PTR Utils_RestoreWindowPositionEx(HWND hwnd, int flags, HANDLE hContact, const char *szModule, const char *szNamePrefix) {
SAVEWINDOWPOS swp;
- swp.hwnd=hwnd; swp.hContact=hContact; swp.szModule=szModule; swp.szNamePrefix=szNamePrefix;
+ swp.hwnd = hwnd; swp.hContact = hContact; swp.szModule = szModule; swp.szNamePrefix = szNamePrefix;
return CallService(MS_UTILS_RESTOREWINDOWPOSITION, flags, (LPARAM)&swp);
}
__inline static INT_PTR Utils_RestoreWindowPosition(HWND hwnd, HANDLE hContact, const char *szModule, const char *szNamePrefix) {
@@ -258,8 +258,8 @@ __inline static INT_PTR Utils_RestoreWindowPositionNoMove(HWND hwnd, HANDLE hCon }
//Moves a RECT inside screen if it is outside.It works with multiple monitors v0.9.0.4+
-//wParam=RECT *
-//lParam=0
+//wParam = RECT *
+//lParam = 0
//returns <0 on error, 0 if not changed the rect, 1 if changed the rect
#define MS_UTILS_ASSERTINSIDESCREEN "Utils/AssertInsideScreen"
__inline static INT_PTR Utils_AssertInsideScreen(RECT *rc) {
@@ -270,17 +270,17 @@ __inline static INT_PTR Utils_AssertInsideScreen(RECT *rc) { #define WNDCLASS_COLOURPICKER _T("ColourPicker")
-#define CPM_SETCOLOUR 0x1000 //lParam=new colour
+#define CPM_SETCOLOUR 0x1000 //lParam = new colour
#define CPM_GETCOLOUR 0x1001 //returns colour
-#define CPM_SETDEFAULTCOLOUR 0x1002 //lParam=default, used as first custom colour
+#define CPM_SETDEFAULTCOLOUR 0x1002 //lParam = default, used as first custom colour
#define CPM_GETDEFAULTCOLOUR 0x1003 //returns colour
#define CPN_COLOURCHANGED 1 //sent through WM_COMMAND
/***************************** Bitmap Filter (0.1.2.1+) *************************/
//Loads a bitmap v0.1.2.1+
-//wParam=0
-//lParam=(LPARAM)(const char*)filename
+//wParam = 0
+//lParam = (LPARAM)(const char*)filename
//returns HBITMAP on success, NULL on failure
//This function uses OleLoadPicturePath() so supports BMP, JPEG and GIF. It may
//support PNG on future versions of Windows (or XP for that matter)
@@ -297,8 +297,8 @@ __inline static INT_PTR Utils_AssertInsideScreen(RECT *rc) { #endif
//Gets the filter strings for use in the open file dialog v0.1.2.1+
-//wParam=cbLengthOfBuffer
-//lParam=(LPARAM)(char*)pszBuffer
+//wParam = cbLengthOfBuffer
+//lParam = (LPARAM)(char*)pszBuffer
//Returns 0 on success, nonzero on failure
//See the MSDN under OPENFILENAME.lpstrFilter for the formatting
//An 'All Bitmaps' item is always first and 'All Files' is last.
@@ -308,8 +308,8 @@ __inline static INT_PTR Utils_AssertInsideScreen(RECT *rc) { //Saves a path to a relative path (from the miranda directory)
//Only saves as a relative path if the file is in the miranda directory (or
//sub directory)
-//wParam=(WPARAM)(char*)pszPath
-//lParam=(LPARAM)(char*)pszNewPath
+//wParam = (WPARAM)(char*)pszPath
+//lParam = (LPARAM)(char*)pszNewPath
//pszPath is the path to convert and pszNewPath is the buffer that
//the new path is copied too. pszNewPath MUST be of the size MAX_PATH.
//Returns numbers of chars copied.
@@ -317,8 +317,8 @@ __inline static INT_PTR Utils_AssertInsideScreen(RECT *rc) { #define MS_UTILS_PATHTORELATIVE "Utils/PathToRelative"
//Saves a path to a absolute path (from the miranda directory)
-//wParam=(WPARAM)(char*)pszPath
-//lParam=(LPARAM)(char*)pszNewPath
+//wParam = (WPARAM)(char*)pszPath
+//lParam = (LPARAM)(char*)pszNewPath
//pszPath is the path to convert and pszNewPath is the buffer that
//the new path is copied too. pszNewPath MUST be of the size MAX_PATH.
//Returns numbers of chars copied.
@@ -326,21 +326,21 @@ __inline static INT_PTR Utils_AssertInsideScreen(RECT *rc) { #define MS_UTILS_PATHTOABSOLUTE "Utils/PathToAbsolute"
//Creates a directory tree (even more than one directories levels are missing) 0.7.0+
-//wParam=0 (unused)
-//lParam=(LPARAM)(char*)pszPath - directory to be created
+//wParam = 0 (unused)
+//lParam = (LPARAM)(char*)pszPath - directory to be created
//Returns 0 on success error code otherwise
//Unicode version is available since 0.7.0
#define MS_UTILS_CREATEDIRTREE "Utils/CreateDirTree"
// Generates Random number of any length
-//wParam=size - length of the random number to generate
-//lParam=(LPARAM)(char*)pszArray - pointer to array to fill with random number
+//wParam = size - length of the random number to generate
+//lParam = (LPARAM)(char*)pszArray - pointer to array to fill with random number
//Always returns 0
#define MS_UTILS_GETRANDOM "Utils/GetRandom"
//Replace variables in text
-//wParam=(char*/TCHAR*/WCHAR*)string (depends on RVF_UNICODE/RVF_TCHAR flag)
-//lParam=(REPLACEVARSDATA *) data about variables, item with key=0 terminates the list
+//wParam = (char*/TCHAR*/WCHAR*)string (depends on RVF_UNICODE/RVF_TCHAR flag)
+//lParam = (REPLACEVARSDATA *) data about variables, item with key = 0 terminates the list
//returns new string, use mir_free to destroy
// variables known by the core:
diff --git a/include/m_xml.h b/include/m_xml.h index fe6932a41c..24cb21bf4f 100644 --- a/include/m_xml.h +++ b/include/m_xml.h @@ -32,10 +32,10 @@ typedef int XML_ELEMENT_POS; // XML_ELEMENT_POS is not interchangeable with simp typedef enum
{
- XML_ELEM_TYPE_CHILD = 0,
+ XML_ELEM_TYPE_CHILD = 0,
XML_ELEM_TYPE_ATTRIBUTE = 1,
- XML_ELEM_TYPE_TEXT = 2,
- XML_ELEM_TYPE_CLEAR = 3,
+ XML_ELEM_TYPE_TEXT = 2,
+ XML_ELEM_TYPE_CLEAR = 3,
}
XML_ELEMENT_TYPE;
@@ -62,8 +62,8 @@ typedef struct HXML (*getNextNode)(HXML node);
LPCTSTR (*getName)(HXML);
HXML (*getParent)(HXML);
- LPCTSTR (*getText)(HXML); // = getTextByIndex(HXML, 0)
- void (*setText)(HXML, LPCTSTR); // = setTextByIndex(HXML, LPCTSTR, 0)
+ LPCTSTR (*getText)(HXML); //=getTextByIndex(HXML, 0)
+ void (*setText)(HXML, LPCTSTR); //=setTextByIndex(HXML, LPCTSTR, 0)
LPCTSTR (*getAttr)(HXML, int i);
LPCTSTR (*getAttrName)(HXML, int i);
diff --git a/include/newpluginapi.h b/include/newpluginapi.h index 1f66cdc090..0629d292a8 100644 --- a/include/newpluginapi.h +++ b/include/newpluginapi.h @@ -117,14 +117,14 @@ typedef struct PLUGININFOEX_tag //Miranda/System/LoadModule event
//called when a plugin is being loaded dynamically
-//wParam=PLUGININFOEX*
-//lParam=HINSTANCE of the loaded plugin
+//wParam = PLUGININFOEX*
+//lParam = HINSTANCE of the loaded plugin
#define ME_SYSTEM_MODULELOAD "Miranda/System/LoadModule"
//Miranda/System/UnloadModule event
//called when a plugin is being unloaded dynamically
-//wParam=PLUGININFOEX*
-//lParam=HINSTANCE of the plugin to be unloaded
+//wParam = PLUGININFOEX*
+//lParam = HINSTANCE of the plugin to be unloaded
#define ME_SYSTEM_MODULEUNLOAD "Miranda/System/UnloadModule"
//see modules.h for what all this stuff is
diff --git a/include/win2k.h b/include/win2k.h index 9ff57530b0..3565a967d2 100644 --- a/include/win2k.h +++ b/include/win2k.h @@ -97,7 +97,7 @@ File created by Christian Kästner, and tweaked a bit by Richard Hughes*/ #define DTBG_COMPUTINGREGION 0x00000010 // TRUE if calling to compute region
#define DTBG_MIRRORDC 0x00000020 // assume the hdc is mirrorred and
// flip images as appropriate (currently
- // only supported for bgtype=imagefile)
+ // only supported for bgtype = imagefile)
#define DTBG_NOMIRROR 0x00000040 // don't mirror the output, overrides everything else
typedef struct _DTBGOPTS
@@ -500,11 +500,11 @@ File created by Christian Kästner, and tweaked a bit by Richard Hughes*/ typedef
enum TBPFLAG
{
- TBPF_NOPROGRESS = 0,
- TBPF_INDETERMINATE = 0x1,
- TBPF_NORMAL = 0x2,
- TBPF_ERROR = 0x4,
- TBPF_PAUSED = 0x8
+ TBPF_NOPROGRESS = 0,
+ TBPF_INDETERMINATE = 0x1,
+ TBPF_NORMAL = 0x2,
+ TBPF_ERROR = 0x4,
+ TBPF_PAUSED = 0x8
} TBPFLAG;
typedef struct THUMBBUTTON *LPTHUMBBUTTON;
|