nn::camera::CTR::IsAutoWhiteBalance Function

Syntax

nn::Result IsAutoWhiteBalance(
     bool * pOn,
     CameraSelect select
);

Parameters

Name Description
out pOn Returns TRUE if enabled, and FALSE otherwise.
in select Specifies the camera for which to check settings.

Return Values

Returns the function's execution result. Returns one of the Result values listed below.
Value Description
Result::IsSuccess Process was successful.
ResultIsSleeping This function is unusable because the system cover is closed.
ResultFatalError There may be something physically wrong with the camera.

Description

Gets whether automatic white balance is enabled.

Note: This function may block for an extended period if a camera is restarting.

Revision History

2010/07/17
Added explanation about operation during restart.
2010/07/14
Deleted related text following deletion of SynchronizeWhiteBalance function.
2010/06/18
Added information about this function's relationship with the SynchronizeWhiteBalance function.
2010/02/02
Initial version.

CONFIDENTIAL