EssOtlDeleteQueryHint

Deletes the query hint indicated by the input outline and hint number.

Hints are numbered from 1 to n. This function deletes the specified query hint and decreases the number of hints with one. All hints with a hintNum greater than the deleted hint are renumbered to hintNum - 1.

Syntax

ESS_FUNC_M EssOtlDeleteQueryHint (hOutline, hintNum);

Parameter	Data Type	Description
hOutline	ESS_HOUTLINE_T	Outline context handle (input).
hintNum	ESS_SHORT_T	Query hint number (input).

Notes

Query hints enable you to influence normal view selection by informing Essbase about the profile of common queries.
This function is applicable only to Release 9.3 or higher aggregate storage databases.

Return Value

Returns 0 if successful.

Example

 ESS_STS_T         sts = ESS_STS_NOERR;
 ESS_HOUTLINE_T    hOutline = ESS_NULL;
 ESS_PMBRINFO_T    pMemberInfo = ESS_NULL;
 ESS_SHORT_T       nmHints = 0;
 ESS_SHORT_T       i, j, hintNum;
 ESS_HMEMBER_T     hMember[10]; /* (nm real dimensions) < 10 */

 /* Code to assign hOutline variable omitted */
 /* Code to assign hintNum variable omitted */
   
 sts = EssOtlGetNumQueryHints(hOutline, &nmHints);
 if (sts) return sts;  /* error out */

 if (hintNum <= nmHints)
 {
  sts = EssOtlDeleteQueryHint(hOutline, hintNum);
  if (sts)
   printf("Error [%s] deleting query hint (%d)\n", sts, hintNum);
  else
   printf("Query-Hint number: (%d) deleted\n", hintNum);
 }
 else
 {
  printf("Query-Hint number: (%d) does not exist\n", hintNum);
 }