int ImgOptionNames(HANDLE hImage, LPSTR lpBuff, DWORD* cxBuff);

Returns a list of all the option settings used in the current image.

 

Parameter	Type	Description
hImage	HANDLE	Identifies the Image
lpBuff	LPSTR	Points to a buffer to receive a null terminated string containing the Option names delimited with | character
cxBuff	DWORD	Points to a DWORD which specifies the length of the buffer pointed to by lpBUFF. If lpBUFF is NULL then this will receive the size of the buffer required to be passed to lpBuff.

 

Return Value

Value	Description
IMG_NOMEM	not an appropriate value
IMG_BAD_PARAM	bad parameters passed into funtion
IMG_INV_POINTER	bad parameters passed into funtion
IMG_OK	value should now be in buffer

 

Example

LPSTR lpRet = NULL;

DWORD cxBuff = 0;

.

.

if (IMG_NOMEM == ImgOptionNames(m_hSrcImg, NULL, &cxBuff)) {

 lpRet = new char[cxBuff];

 if (!(IMG_OK == ImgOptionNames(m_hSrcImg, lpRet, &cxBuff))) {

  delete [] lpRet;

  lpRet = NULL;

 }

}

Comments

If you pass in Null for lpBuff or cxBuff = 0 to this function it will return IMG_NOMEM, and cxBuff will tell you how big the buffer needs to be.

 

 

 

 

---

© 1995-2004 Data Techniques, Inc. All rights reserved.