IShellLink::GetDescription

[Now Supported on Windows NT]

Retrieves the description string for a shell link object.

RESULT STDMETHODCALLTYPE GetDescription(

ISHELLLINK FAR *pShlLnk,  
LPSTR pszName,  
int cchMaxName  
);  

Parameters

pShlLnk

Pointer to the IShellLink interface. In C++, this parameter is implicit.

pszName

Pointer to a buffer that receives the description string.

cchMaxName

Maximum number of characters to copy to the buffer pointed to by pszName.

Return Values

Returns NOERROR if successful or an OLE-defined error value otherwise.

See Also

IShellLink