IDBInfo::GetKeywords

Returns a list of provider-specific keywords.

Syntax

HRESULT GetKeywords(
   LPOLESTR *ppwszKeywords);

Parameters

  • ppwszKeywords
    [out] A pointer to memory in which to return the address of a string. The string contains a comma-separated list of all keywords unique to this provider ? that is, a comma-separated list of keywords that are not in the list in the Comments section. If there are no keywords unique to this provider or if an error occurs, the provider sets *ppwszKeywords to a null pointer.

    The provider allocates memory for the string and returns the address to this memory; the consumer releases this memory with IMalloc::Free when it no longer needs the string.

Return Value

  • S_OK
    The method succeeded.

  • E_FAIL
    A provider-specific error occurred.

  • E_INVALIDARG
    ppwszKeywords was a null pointer.

  • E_OUTOFMEMORY
    The provider was unable to allocate sufficient memory in which to return the keywords.

  • E_UNEXPECTED
    The data source object was in an uninitialized state.

Comments

The following is a list of the keywords from OLE DB:

ABSOLUTE

ESCAPE

OUTPUT

ACTION

EXCEPT

OVERLAPS

ADD

EXCEPTION

PARTIAL

ALL

EXEC

POSITION

ALLOCATE

EXECUTE

PRECISION

ALTER

EXISTS

PREPARE

AND

EXTERNAL

PRESERVE

ANY

EXTRACT

PRIMARY

ARE

FALSE

PRIOR

AS

FETCH

PRIVILEGES

ASC

FIRST

PROCEDURE

ASSERTION

FLOAT

PUBLIC

AT

FOR

READ

AUTHORIZATION

FOREIGN

REAL

AVG

FOUND

REFERENCES

BEGIN

FROM

RELATIVE

BETWEEN

FULL

RESTRICT

BIT

GET

REVOKE

BIT_LENGTH

GLOBAL

RIGHT

BOTH

GO

ROLLBACK

BY

GOTO

ROWS

CASCADE

GRANT

SCHEMA

CASCADED

GROUP

SCROLL

CASE

HAVING

SECOND

CAST

HOUR

SECTION

CATALOG

IDENTITY

SELECT

CHAR

IMMEDIATE

SESSION

CHAR_LENGTH

IN

SESSION_USER

CHARACTER

INDICATOR

SET

CHARACTER_LENGTH

INITIALLY

SIZE

CHECK

INNER

SMALLINT

CLOSE

INPUT

SOME

COALESCE

INSENSITIVE

SQL

COLLATE

INSERT

SQLCODE

COLLATION

INT

SQLERROR

COLUMN

INTEGER

SQLSTATE

COMMIT

INTERSECT

SUBSTRING

CONNECT

INTERVAL

SUM

CONNECTION

INTO

SYSTEM_USER

CONSTRAINT

IS

TABLE

CONSTRAINTS

ISOLATION

TEMPORARY

CONTINUE

JOIN

THEN

CONVERT

KEY

TIME

CORRESPONDING

LANGUAGE

TIMESTAMP

COUNT

LAST

TIMEZONE_HOUR

CREATE

LEADING

TIMEZONE_MINUTE

CROSS

LEFT

TO

CURRENT

LEVEL

TRAILING

CURRENT_DATE

LIKE

TRANSACTION

CURRENT_TIME

LOCAL

TRANSLATE

CURRENT_TIMESTAMP

LOWER

TRANSLATION

CURRENT_USER

MATCH

TRIGGER

CURSOR

MAX

TRIM

DATE

MIN

TRUE

DAY

MINUTE

UNION

DEALLOCATE

MODULE

UNIQUE

DEC

MONTH

UNKNOWN

DECIMAL

NAMES

UPDATE

DECLARE

NATIONAL

UPPER

DEFAULT

NATURAL

USAGE

DEFERRABLE

NCHAR

USER

DEFERRED

NEXT

USING

DELETE

NO

VALUE

DESC

NOT

VALUES

DESCRIBE

NULL

VARCHAR

DESCRIPTOR

NULLIF

VARYING

DIAGNOSTICS

NUMERIC

VIEW

DISCONNECT

OCTET_LENGTH

WHEN

DISTINCT

OF

WHENEVER

DISTINCTROW

ON

WHERE

DOMAIN

ONLY

WITH

DOUBLE

OPEN

WORK

DROP

OPTION

WRITE

ELSE

OR

YEAR

END

ORDER

ZONE

END-EXEC

OUTER

See Also

Reference

IDBInfo::GetLiteralInfo

IDBProperties::GetProperties