IDirectorySearch::GetNextColumnName method

The IDirectorySearch::GetNextColumnName method gets the name of the next column in the search result that contains data.

Syntax


HRESULT GetNextColumnName(
  [in]  ADS_SEARCH_HANDLE hSearchHandle,
  [out] LPWSTR            *ppszColumnName
);

Parameters

hSearchHandle [in]

Provides a handle to the search context.

ppszColumnName [out]

Provides the address of a pointer to a method-allocated string containing the requested column name. If NULL, no subsequent rows contain data.

Return value

This method returns the standard return values, as well as the following:

For other return values, see ADSI Error Codes.

S_OK

The name of the next column containing data was successfully obtained.

E_ADS_BAD_PARAMETER

The search handle is invalid.

S_ADS_NOMORE_COLUMNS

The current column is the last column and remains unchanged.

Remarks

This method allocates sufficient memory for the column name, but the caller must call the FreeADsMem helper function to free this memory when it is no longer needed.

Examples


LPWSTR pszColumn;
m_pSearch->GetFirstRow( hSearch );
printf("Column names are: ");
while( m_pSearch->GetNextColumnName( hSearch, &pszColumn ) != S_ADS_NOMORE_COLUMNS )
{
   printf("%S ", pszColumn );
   FreeADsMem( pszColumn );
}

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2008

Header

Iads.h

DLL

Activeds.dll;
Adsldp.dll;
Adsldpc.dll

IID

IID_IDirectorySearch is defined as 109BA8EC-92F0-11D0-A790-00C04FD8D5A8

See also

IDirectorySearch
FreeADsMem
ADSI Error Codes

 

 

Show: