GopherGetAttribute Function

Retrieves the specific attribute information from the server.

Syntax

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

The actual syntax of this function varies between its ANSI and Unicode implementations. See the Win32 Internet Functions Syntax document for details.

Parameters

hConnect

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

Unsigned long integer value containing the size, in bytes, of the lpBuffer buffer.

lpdwCharactersReturned

Address of an unsigned long integer value that contains the 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

Unsigned long integer value that contains the application-defined value that associates this operation with any application data.

Return Value

Returns TRUE if the request is satisfied, or FALSE otherwise. To get extended error information, call GetLastError or InternetGetLastResponseInfo.

Remarks

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).

Function Information

Windows NT	Use version 4.0 and later. Implemented as ANSI and Unicode functions.
Windows	Use Windows 95 and later. Implemented as ANSI and Unicode functions.
Header	Wininet.h
Import library	Wininet.lib
Minimum availability	Internet Explorer 3.0 (ANSI only), 5 (ANSI and Unicode)

See Also

Microsoft Win32 Internet Functions Overview, Gopher Sessions, Microsoft Win32 Internet Functions Reference, Gopher Functions

Does this content meet your programming needs? Write us!

Back to top