CFLib.org – Common Function Library Project

Description:
This UDF takes the result struct from cfquery and returns the proper generated key from that struct.

Return Values:
Returns a value.

Example:

<cfquery name="insertArtist" datasource="cfartgallery" result="r">
insert into artists
(firstName, lastName)
values(
'todd','sharp'
)
</cfquery>
<cfquery name="getArtists" datasource="cfartgallery">
select *
from artists
</cfquery>
<cfdump var="#getArtists#">
<cfoutput>#getGeneratedKey(r)#</cfoutput>

Parameters:

Full UDF Source:

<!---
 Normalizes the various possible returned keys in the cfquery result struct.
 
 @param resultStruct 	 Structure. (Required)
 @return Returns a value. 
 @author Todd Sharp (&#116;&#111;&#100;&#100;&#64;&#99;&#102;&#115;&#105;&#108;&#101;&#110;&#99;&#101;&#46;&#99;&#111;&#109;) 
 @version 1, October 14, 2008 
--->
<cffunction name="getGeneratedKey" hint="i normalize the key returned from cfquery" output="false">
	<cfargument name="resultStruct" hint="the result struct returned from cfquery" />
	<cfif structKeyExists(arguments.resultStruct, "IDENTITYCOL")>
		<cfreturn arguments.resultStruct.IDENTITYCOL />
	<cfelseif structKeyExists(arguments.resultStruct, "ROWID")>
		<cfreturn arguments.resultStruct.ROWID />
	<cfelseif structKeyExists(arguments.resultStruct, "SYB_IDENTITY")>
		<cfreturn arguments.resultStruct.SYB_IDENTITY />
	<cfelseif structKeyExists(arguments.resultStruct, "SERIAL_COL")>
		<cfreturn arguments.resultStruct.SERIAL_COL />	
	<cfelseif structKeyExists(arguments.resultStruct, "GENERATED_KEY")>
		<cfreturn arguments.resultStruct.GENERATED_KEY />
	<cfelse>
		<cfreturn />
	</cfif>
</cffunction>