GopherGetAttributeGopherGetAttribute*
*



Contents  *



Index  *Topic Contents
*Previous Topic: GopherFindFirstFile
*Next Topic: GopherGetLocatorType

GopherGetAttribute

BOOL GopherGetAttribute(
    IN HINTERNET hGopherSession,
    IN LPCSTR lpszLocator,
    IN LPCSTR lpszAttributeName,
    OUT LPBYTE lpBuffer,
    IN DWORD dwBufferLength,
    OUT LPDWORD lpdwCharactersReturned,
    IN GOPHER_ATTRIBUTE_ENUMERATOR lpfnEnumerator,
    IN DWORD dwContext
);

Allows an application to retrieve specific attribute information from the server.

hGopherSession
Handle to a Gopher session returned by InternetConnect.
lpszLocator
Address of a string that identifies the item at the Gopher server on which to return attribute information.
lpszAttributeName
Address of a space-delimited string specifying the names of attributes to return. If lpszAttributeName is NULL, GopherGetAttribute returns information about all attributes.
lpBuffer
Address of an application-defined buffer from which attribute information is retrieved.
dwBufferLength
Size, in bytes, of the lpBuffer buffer.
lpdwCharactersReturned
Number of characters read into the lpBuffer buffer.
lpfnEnumerator
Address of a callback function that enumerates each attribute of the locator. This parameter is optional. If it is NULL, all the Gopher attribute information is placed into lpBuffer. If lpfnEnumerator is specified, the callback function is called once for each attribute of the object.
The callback function receives the address of a single GOPHER_ATTRIBUTE_TYPE structure with each call. The enumeration callback function allows the application to avoid having to parse the Gopher attribute information.
dwContext
Application-defined value that associates this operation with any application data.

Generally, applications call this function after calling GopherFindFirstFile or InternetFindNextFile.

The size of the lpBuffer parameter must be equal to or greater than the value of MIN_GOPHER_ATTRIBUTE_LENGTH (currently defined in Wininet.h as 256 bytes).

Up Top of Page
© 1997 Microsoft Corporation. All rights reserved. Terms of Use.