DBPARAMETER structure (cmdtree.h)

Note

Indexing Service is no longer supported as of Windows XP and is unavailable for use as of Windows 8. Instead, use Windows Search for client side search and Microsoft Search Server Express for server side search.

The DBPARAMETER structure is used to define values for scalar parameters.

Syntax

typedef struct tagDBPARAMETER {
  LPOLESTR     pwszName;
  ITypeInfo    *pTypeInfo;
  DB_NUMERIC   *pNum;
  DBLENGTH     cbMaxLength;
  DBPARAMFLAGS dwFlags;
  DBTYPE       wType;
} DBPARAMETER;

Members

pwszName

parameter name

pTypeInfo

if not a null pointer, type is described by the ITypeInfo

pNum

Structure describing the precision, scale and value of the numeric value.

cbMaxLength

the maximum length of the parameter

dwFlags

bitmask describing parameter characteristics

wType

type of the parameter

Remarks

Note that there is no entry for the ordinal position of the parameter. The assumption is that the ordinal position will be determined by the provider after evaluating the tree as a whole, and not by assigning a specific value to an individual member within the tree. Data consumers can determine the ordinal position based on the name using ICommandWithParameters::MapParameterNames. For more information about the interface, see ICommandWithParameters.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	cmdtree.h