Help File/Documentation Issues. (Discussion Only)

[AZJIO]

TCP...

If @error Then
    ; The server is probably offline/port is not opened on the server.
    $iError = @error
    MsgBox(BitOR($MB_SYSTEMMODAL, $MB_ICONHAND), "", "Client:" & @CRLF & "Could not connect, Error code: " & $iError)
    Return False
EndIf

If @error Then
    ; The server is probably offline/port is not opened on the server.
    MsgBox(BitOR($MB_SYSTEMMODAL, $MB_ICONHAND), "", "Client:" & @CRLF & "Could not connect, @error = " & @error)
    Return False
EndIf

Whether it is necessary to make comments on the obvious? The set of comments complicates reading a code.

; Display the successful message.
MsgBox($MB_SYSTEMMODAL, "", "Client:" & @CRLF & "File received.")

.

[guinness]

Even though I'm not moderating thread as per the huge red text in the first post, I don't see a problem with the TCP examples. They're better than what they once were to FireFox.

[jchd]

AZJIO,

The proposed version resets @error at exit of BitOR, making its display irrelevant. This is most probably why the current version saves it.

[mLipok]

I noticed as follows:

in the documentation for the function:

 

_WinAPI_CreateCompatibleBitmap

_WinAPI_CreateCompatibleDC

_WinAPI_DeleteDC

_WinAPI_PtInRectEx

_WinAPI_DrawIconEx

_WinAPI_SetWindowLong

 

in the examples section, there are no examples, but the documentation for other functions, quite often have very good examples, that use these functions.

 

For example, the documentation for the function

_WinAPI_BeginPaint

provides an example of using all the above mentioned functions.

 

 

I suggest you consider that in the Examples section, add the appropriate links to other examples that also use the function.

 

EDIT:

If the idea proves to be useful, I could even deal with the creation of appropriate tools for the analysis of such cases, and of course added, relevant links.

Edited September 7, 2013 by mlipok

[AZJIO]

jchd

I forgot about BitOR. I reworked for version 3.3.8.1 and deleted BitOR, therefore suggested variable unnecessary.

 

 

_WinAPI_CopyIcon (and others where there are no examples)

In the "examples" an error has occurred

 

mlipok

I offered about forty examples. Still I don't see them in the help file

 

examples.7z (73 examples)

http://dfiles.ru/files/4665ohsrz

http://rghost.ru/48616031

Edited September 7, 2013 by AZJIO

[guinness]

mlipok

I offered about forty examples. Still I don't see them in the help file

Because they don't conform to the standards we expect in the help file examples & thus need to be tidied up.

[AZJIO]

UDPCloseSocket

Example does not include the use of

[guinness]

UDPCloseSocket

Example does not include the use of

Does in my test version, so I'm guessing it is fixed.

[AZJIO]

guinness

Because they don't conform to the standards we expect in the help file examples & thus need to be tidied up.

You can add and improve over time. It will be more efficiently than not to have.

[guinness]

If an MVP/Dev wants to add them, then they can.

[AZJIO]

They probably busy. Someone has to take responsibility. Check and give the green light.

[guinness]

They probably busy. Someone has to take responsibility. Check and give the green light.

I do take responsibility hence why I'm not adding them until they conform to the guidelines previously explained. I discussed in the MVP Forum and it was agreed that changes would have to be made before adding.

Feel free to create a topic in Examples.

Edited September 7, 2013 by guinness

[AZJIO]

Feel free to create a topic in Examples.

 

For me, all the examples are working. I do not understand why I have to create a topic. I offered ready-made examples.

Edited September 7, 2013 by AZJIO

[guinness]

All examples in the help file pass Au3Check with the following parameters...

#AutoIt3Wrapper_Au3Check_Parameters=-d -w 1 -w 2 -w 3 -w- 4 -w 5 -w 6 -w- 7

This is one reason why they need to be tidied up. As you rightly pointed out a MVP probably doesn't have time, well neither do I. I would rather spend what little free time I have fixing known issues.

[AZJIO]

The default is an empty string. Does not make sense to assign a value.

Local $sReceived = ""

Local $sReceived

[FireFox]

 

The default is an empty string. Does not make sense to assign a value.

Local $sReceived = ""

Local $sReceived

Yes it does, it's explicit.

[AZJIO]

DllCall
Example 3
If I got "Icon-Index: 0" what button I pressed (OK or Cancel)?

[trancexx]

DllCall

Example 3

If I got "Icon-Index: 0" what button I pressed (OK or Cancel)?

Functionality of PickIconDlg can't be guaranteed for systems above Vista. Maybe that's the reason. It's the example that shouldn't be.

[AZJIO]

Maybe that's the reason

 

The reason is that the >two times I said that you need to add the line

If @error Or Not $aRes[0] Then Exit

GUICtrlCreatePic

Example 2

It is correct to assign global hotkeys for GUI? Maybe better "GUISetAccelerators"?

Edited September 8, 2013 by AZJIO

[trancexx]

The reason is that the two times I said that you need to add the line

If @error Or Not $aRes[0] Then Exit

Who ever wrote the example defined the ret value type as "none", so no that's not as correct as you say. The example should be removed altogether.