Parameter names are constructed to show the data type of the parameter and to indicate its use:
Where possible, standard names have been used to describe parameters. Where multiple word qualifiers are used, the order of the words is not significant.
For example:
컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴
hdc /* device context handle */
pszFilename /* pointer to a character string */
컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴
The following standard base tags and their associated type names are defined:
旼컴컴컴컴컫컴컴컴컴컴쩡컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴커 쿟ag 쿏ata Type 쿏escription � 쳐컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿯 쿍OOL 쿑lag or Boolean variable. The qualifier � � � 쿭escribes the condition associated with � � � 퀃he flag when it is TRUE. For example, � � � 쿯Success is TRUE if successful and FALSE� � � 쿶f not; whereas fError is TRUE if an � � � 쿮rror occurred and FALSE if no error � � � 쿽ccurred. For objects of type BOOL, the � � � 퀆alue 0 implies FALSE and any nonzero � � � 퀆alue implies TRUE. � 쳐컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿬h 쿎HAR 쿞igned eight-bit quantity; a character. � 쳐컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 퀂 쿞HORT 쿞igned 16-bit quantity; a SHORT. This is� � � 쿽ften used in place of us when it does � � � 쿻ot matter whether the value is signed � � � 쿽r unsigned. � 쳐컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿹 쿗ONG 쿞igned 32-bit quantity; a LONG. This is � � � 쿽ften used in place of ul when it does � � � 쿻ot matter whether the value is signed � � � 쿽r unsigned. � 쳐컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 퀅ch 쿢CHAR 쿢nsigned eight-bit quantity; a byte. � � � 쿞ame as b. � 쳐컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 퀅s 쿢SHORT 쿢nsigned 16-bit quantity. � 쳐컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 퀅l 쿢LONG 쿢nsigned 32-bit quantity. � 쳐컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿫 쿍YTE 쿢nsigned eight-bit quantity; a byte. � � � 쿞ame as uch. � 쳐컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 퀂z 쿎HAR[ ] 쿙ULL-terminated string of characters. � 쳐컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿯b 쿢CHAR 쿍yte of flags, that is, an array of � � � 쿯lags packed in a BYTE. � 쳐컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿯s 쿢SHORT 쿞HORT of flags, that is, an array of � � � 쿯lags packed in a USHORT. � 쳐컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿯l 쿢LONG 쿗ONG of flags, that is, an array of � � � 쿯lags packed in a ULONG. The three � � � 쿾receding types are used when more than � � � 쿽ne flag is combined into a byte, SHORT � � � 쿽r LONG. Typically, the values are � � � 쿬ombined with the OR operator and are � � � 쿪lways unsigned. � 쳐컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 퀁 쿝EAL 쿝eal number, single precision 32-bits. � 쳐컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 퀁d 쿏OUBLE 쿝eal number, double precision 64-bits. � 쳐컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿾fn � 쿛ointer to a function. � 쳐컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 퀈 � 쿦-coordinate. � 쳐컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 퀉 � 쿧-coordinate. � 읕컴컴컴컴컨컴컴컴컴컴좔컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴켸
The following standard prefixes are also defined:
旼컴컴컴컴컫컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿛refix 쿏escription � 쳐컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿾 �32-bit pointer for an 80386 microprocessor. For � � 쿮xample, pch is a pointer to a character. � 쳐컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿪 쿌rray. For example, ach is an array of characters.� 쳐컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿶 쿔ndex to an array. For example, an ich is used to � � 쿶ndex an ach. � 쳐컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿬 쿎ount. For example, cch is a count of characters. � 쳐컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿭 쿏elta or difference between instances of a type. � � 쿑or example, dx is the difference between two � � 퀆alues of x. � 쳐컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿴 쿓andle. A value that uniquely identifies an object� � 쿫ut cannot directly be used to access it. For � � 쿮xample, hps is a PS handle. � 쳐컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿺p 쿘apping array. This prefix is always followed by � � 퀃wo base types rather than one and represents the � � 쿺ost general case of an array. Mathematically, an � � 쿪rray is a function mapping the index to the value� � 퀂tored in the array. The prefix mp is an � � 쿪bbreviation of map. In the construct mpab, a is � � 퀃he type of the index and b is the type of the � � 퀆alue stored in the array. In most cases, the only� � 퀃ype that is important is the type of the value. � � 쿟he index is usually an integer with no other � � 쿺eaning (the a prefix is used in this instance). � 쳐컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿽ff 쿚ffset. Generally used as an offset within a data � � 퀂tructure. The actual address of the element � � 퀇ithin the data structure is derived by adding an � � 쿽ffset to a pointer, which points to the beginning� � 쿽f the data structure. Normally, OFF is a byte � � 쿽ffset. For example: pfoo = (FOO *)((BYTE � � �*)pfooBase + 0fff00) � 쳐컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿶d 쿔dentifier. This is generally used for values that� � 쿶dentify some object. Usually the association of � � 퀃he ID value and the object are established by the� � 쿾rogrammer. For example, all windows are � � 쿶dentified by their Window ID, which can be set � � 쿪nd queried by the programmer. � 쳐컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿬md 쿎ommand. Used for command values, typically as � � 쿯unction parameters. � 읕컴컴컴컴컨컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴�
Some parameters are used in pairs; the qualifiers that are used reflect the relationship between the two variables. For example:
旼컴컴컴컴컴컫컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴커 쿛arameter 쿏escription � 쳐컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿑irst/Last 쿑irst and last elements in a set. These are typically used with � � 쿶ndexes or pointers (pchFirst, pchLast). Both values represent � � 퀆alid values (compare with Min/Max below). For all valid values of � � 퀈: xFirst <= x <= xLast. The use of > with First or < with Last is � � 쿪lmost always an "off-by-one" error. � � 쿑or example, to determine whether an ich is within ichFirst and � � 쿶chLast: if (ich >= ichFirst && ich <= ichLast) � � � ... � � 쿌 typical loop: � � � for (ich = ichFirst; ich <= ichLast; ich++) � � � ... � 쳐컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿘in/Max 쿞imilar to First/Last except that Max is not a valid value in the � � 퀂et (Min is a valid value). For all valid values of x in the set: � � 퀈Min < = x < xMax. The use of > with Min or < = with Max is almost � � 쿪lways an "off-by-one" error. � � 쿑or example, to determine whether an ich is within ichMin and � � 쿶chMax: if (ich >= ichMin && ich < ichMax) � � � ... � � 쿌 typical loop: � � � for (ich = ichMin; ich < /* or != */ ichMax; ich++) � � � ... � 쳐컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 � 쿟he current value (Cur) qualifier can be used with Min and Max when� � 쿘in or Max can change over time (for example, pbStackMaxCur). � 쳐컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿚ld/New 쿚ld and new. Typically used for values or states when it is � � 쿻ecessary to compare the old and new states of the value. � 쳐컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿙ext/Prev 쿙ext and previous. Typically used in situations in which items are � � 쿫eing enumerated, such as with linked lists. � 쳐컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿞rc/Dst 쿞ource and destination. Typically used in transfer operations. � 쳐컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿟 쿌 temporary value. � 쳐컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿞ave 쿌 temporary saved value. Typically used when saving and restoring � � 퀂ome state. � 쳐컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿎ur 쿎urrent value. � 읕컴컴컴컴컴컨컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴켸
The base types and their prefixes are defined as follows:
旼컴컴컴컴컫컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿏ata Type 쿛refix � 쳐컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿛SZ 쿾sz � 쳐컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿛CH 쿾ch � 쳐컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿓AB 쿴ab � 쳐컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿓PS 쿴ps � 쳐컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� �HDC 쿴dc � 쳐컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿓RGN 쿴rgn � 쳐컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿓BITMAP 쿴bmp � 쳐컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿛LONG 쿾l � 쳐컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿛OINTL 쿾tl � 쳐컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿛OINTL 쿾t � 쳐컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿝ECTL 퀁cl � 쳐컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿝ECTL 퀁c � 쳐컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿓WND 쿴wnd � 쳐컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿥POINT 퀇pt � 쳐컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿥RECT 퀇rc � 쳐컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿑IXED 쿯x � 읕컴컴컴컴컨컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴�
Parameters for defined structures are the defined parameter names. For example:
컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴
AREADEFS struct
{
defSet
fFlags
CodePage
}AREADEFS
컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴
System-defined constants and flags are represented as two or more uppercase WORDs or mnemonic abbreviations separated by underscores. For example, SYS_CONSTANT and SYS_FLAG.