Commentaddress

int Commentaddress(ulong addr,int typelist,wchar_t *comment,int len);

Given memory address in the contents of the debugged application, returns comment associated with this address.


Parameters:

addr
(in) Address of the memory location in the contents of the debugged application
typelist
(in) Combination of bit flags that determine which kinds of information must be checked, in the following order:
COMM_USER - check for user-defined comment
COMM_MARK - check for important arguments
COMM_PROC - check for procedure description
COMM_ALL - all of the above
Commentaddress() returns comment of the first available type. It does not attempt to concatenate several comments
comment
(out) UNICODE string of length at least len wide characters that receives comment
len
(in) Length, in wide characters, of the buffer pointed to by comment


Return values:
Length of comment in wide characters, not including the terminal null, or 0 if there is no comment associated with addr


See also:
Decodeaddress(), Decoderelativeoffset(), Getanalysercomment(), Getloopcomment(), Getproccomment(), Getswitchcomment(), Squeezename(), Uncapitalize()