Function ChangeVLKey($VOL_PROD_KEY)
  Dim $obj, $objects, $x
  ;Key is without hyphens (ABCDEFGHIJKLMNOPQRSTUVWXY) 
  $objects = GetObject("winmgmts:{impersonationLevel=impersonate}").InstancesOf("win32_WindowsProductActivation")
  If @Error <> 0
    Exit @Error
  EndIf
  For Each $obj in $objects
    $x = $obj.SetProductKey($VOL_PROD_KEY)
    $ChangeVLKey = @error
  Next
  Exit @error
EndFunction

$gimme_answer = ChangeVLKey("ABCDEFGHIJKLMNOPQRSTUVWX")
? $gimme_answer

Function ChangeVLKey($VOL_PROD_KEY)
  Dim $obj, $objects, $result
  ;Key is without hyphens (ABCDEFGHIJKLMNOPQRSTUVWXY)

  $objects = GetObject("winmgmts:{impersonationLevel=impersonate}").InstancesOf("win32_WindowsProductActivation")
  $ChangeVLKey = @error
  For Each $obj in $objects
    $result = $obj.SetProductKey($VOL_PROD_KEY)
    $ChangeVLKey = @error
  Next
EndFunction

If @error <> 0
  exit @error
Else
  $ChangeVLKey = $result
EndIf

$msg = ChangeVLKey("ABCDEFGHIJKLMNOPQRSTUVWXY")
? $msg

Exit @ERROR

Exit $ChangeVLKey

Function ChangeVLKey($VOL_PROD_KEY)
  Dim $obj, $objects, $result
  ;Key is without hyphens (ABCDEFGHIJKLMNOPQRSTUVWXY)
 
  $objects = GetObject("winmgmts:{impersonationLevel=impersonate}").InstancesOf("win32_WindowsProductActivation")
 
  If Not @ERROR
    For Each $obj in $objects
      $result = $obj.SetProductKey($VOL_PROD_KEY)
    Next
  EndIf
  $ChangeVLKey = @error
  Exit $ChangeVLKey
EndFunction

$Return = ChangeVLKey("VP6K44HMRQ86W8YH78DXD2YBQ"); HP1
;$Return = ChangeVLKey("W789C42CGQGPXHRHV4DJCMG4Y"); HP2
;$Return = ChangeVLKey("HPMV67JGMXWMJXRHT3JYGYB4Q"); HP3

? $Return
Get $a

Function ChangeVLKey($VOL_PROD_KEY)
	Dim $obj, $objects, $result
	;Key is without hyphens (ABCDEFGHIJKLMNOPQRSTUVWXY)
	
	$objects = GetObject("winmgmts:{impersonationLevel=impersonate}").InstancesOf("win32_WindowsProductActivation")
	If Not @ERROR
		For Each $obj in $objects
			$result = $obj.SetProductKey($VOL_PROD_KEY)
			$ChangeVLKey = @error
;			? "ActivationRequired: " + $obj.ActivationRequired
;			? "Caption: " + $obj.Caption
;			? "Description: " + $obj.Description
;			? "IsNotificationOn: " + $obj.IsNotificationOn
;			? "ProductID: " + $obj.ProductID
;			? "RemainingEvaluationPeriod: " + $obj.RemainingEvaluationPeriod
;			? "RemainingGracePeriod: " + $obj.RemainingGracePeriod
;			? "ServerName: " + $obj.ServerName
;			? "SettingID: " + $obj.SettingID
		Next
	EndIf
	$ChangeVLKey = @error
	Exit $ChangeVLKey
EndFunction

Function ChangeVLKey($VOL_PROD_KEY)
  Dim $obj, $objects
  ;Key is without hyphens (ABCDEFGHIJKLMNOPQRSTUVWXY) 
  $objects = GetObject("winmgmts:{impersonationLevel=impersonate}").InstancesOf("win32_WindowsProductActivation")
  If @ERROR
    ;ChangeVLKey should not have a value if we got an error 
    $ChangeVLKey = Val('&' + Right(DecToHex(@ERROR), 4))
    ;Convert the error to readable format 
    Exit Val('&' + Right(DecToHex(@ERROR), 4))
  EndIf
  For Each $obj in $objects
    $ChangeVLKey = $obj.SetProductKey($VOL_PROD_KEY)
  Next
  ;Assumes we got here okay so exit with no error 
  Exit @ERROR
EndFunction

Function ChangeVLKey($VOL_PROD_KEY)
  Dim $obj, $objects, $result
  ;Key is without hyphens (ABCDEFGHIJKLMNOPQRSTUVWXY)
 
  $objects = GetObject("winmgmts:{impersonationLevel=impersonate}").InstancesOf("win32_WindowsProductActivation")
 
  If Not @ERROR
    For Each $obj in $objects
      $result = $obj.SetProductKey($VOL_PROD_KEY)
    Next
  EndIf
  $ChangeVLKey = @error
  Exit $ChangeVLKey
EndFunction

Quote:

---

The problem is that the WMI action will return '0' to indicate success, thus if someone checks for the UDF return but not the @ERROR, it'll evaluate to 'success' even though the action failed

---

If Func()
  ; got a reply - don't care, just do!
Else
  ; No reply - there's a problem, check @ERROR
EndIf

$X = Func()
If $X
  ; got a reply - OK to process the data
Else
  ; No reply - there's a problem, check @ERROR
EndIf

If Open(1, 'Filename', 2) = 0

$RC = -3
$Ct = 0
While $RC = -3 And $Ct < 10
  $RC = Open(1, 'Filename', 2) = 0
  $Ct = $Ct + 1
  If $RC = -3  Sleep .5 EndIf
Loop

Quote:

---

I think that those examples are special cases that return EXTENDED information, and return 0 on success, the opposite of what this and many other functions do.

---

The example script I gave above returns 0 on success or the error which caused the failure. This is consistent with...

AddKey(), AddPrinterConnection(), AddProgramGroup(), AddProgramItem(), BackupEventLog(), DelKey(), LoadHive(), LogEvent(), SendKeys(), SendMessage(), SetConsole(), ShutDown(), WriteProfileString()

... and others.

Maybe I misunderstand. Wouldn't be the first time

Quote:

---

In this UDF example, and the one Doc is referring to, the UDF returns a specific value - valid data.

---

This is not correct. Well, not what you mean anyway

The value of SetProductKey is not a datum as such - it is the same error code that @ERROR is set to:

Quote:

---

SetProductKey Method of the Win32_WindowsProductActivation Class
The SetProductKey WMI class method updates the system product key for a computer.

This topic uses Managed Object Format (MOF) syntax. For information on using this method see Calling a Method.

uint32 SetProductKey(
string ProductKey
);

Parameters
ProductKey
[in] Unique product key that is licensed for use on the computer. Product keys are alphanumeric strings of 25 characters formatted as follows: xxxxx-xxxxx-xxxxx-xxxxx-xxxxx. The product key must be valid for the media type. Media types include retail, volume-licensing, and OEM.
Return Values
If the method succeeds and the product key is valid, the method returns 0 (zero) and the corresponding product key is updated. Otherwise, the method returns one of the WMI error constants.

---

Quote:

---

I was trying to point out that if a function is expected to return data.. maybe "Variable Data" describes it better, that No Data is a better indication of an error (and a reason to check the ERROR macro) than Error Data, which makes you figure out if what you got was Valid Data or Error Data.

---

Quote:

---

Richy says...
When the purpose of a function is to return data then it is reasonable to return either the data on success or a null value on an error - I agree that in this case that returning an error value is unwise.

---

Quote:

---

However, this function never returns any data. It only ever returns an error state.

---

Quote:

---

However, when the function is not expected to return data then it makes sense use the error status as the return value.

---

Well then I would assume in most cases that it would be 0

If that's the case then why do we really need to set it to anything? If it's not expected to return data then as long as one checks for @ERROR and does not find an error then it should have worked, otherwise regardless of what caused the error it would be captured in the EXIT @ERROR code.

Also in your example by using the NOT operator forces one to use KiXtart 4.50 or newer (which is okay )

But as I view it if no data is expected why would you check for data? That's like expecting to really see the Tooth Fairy when you know it's not there.

Code:

---

Function ChangeVLKey($VOL_PROD_KEY)
  Dim $obj, $objects, $result
  ;Key is without hyphens (ABCDEFGHIJKLMNOPQRSTUVWXY)
  $objects = GetObject("winmgmts:{impersonationLevel=impersonate}").InstancesOf("win32_WindowsProductActivation")
  If Not @ERROR
    For Each $obj in $objects
      $result = $obj.SetProductKey($VOL_PROD_KEY)
    Next
  EndIf
  Exit Val('&' + Right(DecToHex(@ERROR), 4))
EndFunction

---

Here we simply exit with the ERROR if anything caused one during that processing which we didn't expect data.

I assume from your point of view that well we would see the error and know that something went wrong, but I'm thinking the opposite in that for a function that does not return data, I won't go looking, I'll only look for an ERROR

Regardless of outcome here I think it has been a good discussion on the subject.

$RC=WriteValue("EZReg\Test", "A MultiString variable", "Line 1|Line 2|Line 3 with a || in it|" "REG_MULTI_SZ")
If @ERROR = 0
  ? "Value written to the registry"
Endif 

Function ChangeVLKey($VOL_PROD_KEY)
  Dim $obj, $objects, $x
  ;Key is without hyphens (ABCDEFGHIJKLMNOPQRSTUVWXY) 
  $objects = GetObject("winmgmts:{impersonationLevel=impersonate}").InstancesOf("win32_WindowsProductActivation")
  If @Error <> 0
    Exit @Error
  EndIf
  For Each $obj in $objects
    $x = $obj.SetProductKey($VOL_PROD_KEY)
    $ChangeVLKey = @error
  Next
EndFunction

Quote:

---

If Exist()

That just doesn't work with 0 for success so he used positive logic for testing.

Returns:
0 File not found
1 File found

---

That is a very bad example to choose

You've assumed that because the function is returning a 1 or a 0 that this is the same as returning an error state.

But is not is it? The 1 or 0 returned by Exist() is data and has nothing to do with the error condition.

This still fits into the simple rule set:

1. If a function is designed to return data it should return FALSE, 0 or null on an error where that will not prejudice the purpose of the function.
   
2. If a function has no explicit return value then it should return an error status where "0" is success.
   

Now the example you have chosen (Exist) is designed to explicitly return a value, so it matches rule 1. If an error occurs then 0 will be returned, which fits it's purpose and the way it is used in scripts.

AScan is a good example of a function which fits rule 1 but cannot return 0 on an error which is a bit of a design error IMO.

1. If a function is designed to return data it should return FALSE, 0 or null on an error where that will not prejudice the purpose of the function.
   
2. If a function has no explicit return value then it should also return 0 on error and non-zero on success so that it is consistent with rule 1.

Quote:

---

That's okay, but you're missing an EXIT code when it's finished. All UDF code should have an Exit code and not just Exit either. This has been discussed in the past and shown that on some occassions it can lead to other problems if an Exit with value is not supplied.

---

  For Each $obj in $objects
    $x = $obj.SetProductKey($VOL_PROD_KEY)
    $ChangeVLKey = @error
  Next
  Exit 0