AdsDDGetProcedureProperty

Advantage Client Engine

Gets a specified property from the data dictionary for a stored procedure.

Syntax

UNSIGNED32 AdsDDGetProcedureProperty( ADSHANDLE hDBConn,

UNSIGNED8 *pucProcName,

UNSIGNED16 usPropertyID,

VOID *pvProperty,

UNSIGNED16 *pusPropertyLen );

Parameters

hDBConn (I)

Handle of a database connection.

pucProcName (I)

The name of the stored procedure in the data dictionary.

usPropertyID (I)

The property to retrieve. (see below for possible values.)

pucProperty (O)

A buffer to hold the property value.

pusPropertyLen (I/O)

Length of given buffer on input, length of returned data on output.

Remarks

AdsDDGetProcedureProperty will retrieve the specified property of the stored procedure from the data dictionary.

The following are the valid values for usPropertyID:

usPropertyID

Description

ADS_DD_COMMENT

The comment string that is stored in the data dictionary.

ADS_DD_PROC_INPUT

The stored procedure input parameters in same format used by AdsCreateTable when describing field definitions.

ADS_DD_PROC_OUTPUT

The stored procedure output parameters in same format used by AdsCreateTable when describing field definitions.

ADS_DD_PROC_SCRIPT

The SQL script that defines the stored procedure. If the stored procedure is not an SQL script, the function will return AE_PROPERTY_NOT_SET.

ADS_DD_PROC_DLL_NAME

The name of the Advantage Extended Procedures file that contains the stored procedure. This property can only be retrieved by users with administrative permissions. See Advantage Data Dictionary User Permissions for more information. If the stored procedure is implemented using an SQL script, the function will return AE_PROPERTY_NOT_SET.

ADS_DD_PROC_DLL_FUNCTION_NAME

The name of the function within the Advantage Extended Procedure file that is called when the procedure is executed. This property can only be retrieved by users with administrative permissions. See Advantage Data Dictionary User Permissions for more information.

ADS_DD_PROC_INVOKE_OPTION

This value determines the format of the stored procedure. At this time, the value is always equal to ADS_STORED_PROC. This property can only be retrieved by users with administrative permissions. See Advantage Data Dictionary User Permissions for more information.

Special Return Codes

AE_INVALID_PROPERTY_ID

Either the value supplied in usPropertyID is not a valid table property or the specified property cannot be retrieved.

AE_INSUFFICIENT_BUFFER

The size of the property to be copied into pvProperty is larger than the buffer size specified by usPropertyLen. The required buffer length is returned in usPropertyLen when this error occurs.

AE_PROPERTY_NOT_SET

The requested property is not set in the data dictionary. No data is returned in pvProperty and usPropertylen.

Example

usBuff = sizeof( aucBuff );

ulRetCode = AdsDDGetProcedureProperty( hConnect,

"first_try",

ADS_DD_PROC_INPUT,

aucBuff,

&usBuff );

printf( "%s\n", aucBuff );

See Also

AdsDDAddProcedure

AdsDDRemoveProcedure

AdsDDSetProcedureProperty

system.storedprocedures